feat: rework NVM access, support incremental NVM modification over serial #12132
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
name: Generate documentation | |
# Run this workflow on all pushes to master and pull requests | |
on: | |
push: | |
branches: | |
- master | |
pull_request: {} | |
merge_group: | |
types: [checks_requested] | |
# Cancel previous PR/branch runs when a new commit is pushed | |
concurrency: | |
group: 'generate-docs-${{ github.ref }}' | |
cancel-in-progress: true | |
jobs: | |
# This job checks if the docs can be generated and produce changes | |
# If they do, a PR will be created with the changes | |
check-and-update: | |
# Don't run in forks | |
if: github.repository == 'zwave-js/node-zwave-js' | |
runs-on: ubuntu-latest | |
strategy: | |
matrix: | |
node-version: [18] # This should be LTS | |
steps: | |
- name: Checkout code | |
uses: actions/checkout@v4 | |
with: | |
fetch-depth: 0 | |
- name: Prepare environment | |
uses: ./.github/actions/prepare-env | |
with: | |
node-version: ${{ matrix.node-version }} | |
githubToken: ${{ secrets.GITHUB_TOKEN }} | |
# FIXME: Check if this build step is still needed | |
- name: Compile TypeScript code | |
run: yarn run build | |
- name: Generate documentation | |
run: yarn run docs:generate | |
- name: Generate API report | |
run: yarn run accept-api | |
# Trigger this step only when pushing to master | |
- name: Create or update PR | |
if: | | |
github.event_name == 'push' && | |
github.ref == 'refs/heads/master' | |
uses: actions/github-script@v7 | |
with: | |
github-token: ${{secrets.BOT_TOKEN}} | |
result-encoding: string | |
script: | | |
const main = require(`${process.env.GITHUB_WORKSPACE}/.github/action-scripts/generateTypedDocs.js`); | |
return main({github, context}); |