docs: remove todo #764
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: Pull Request | |
| on: | |
| pull_request: | |
| branches: [main] | |
| permissions: | |
| contents: read | |
| jobs: | |
| pull_request: | |
| uses: makerxstudio/shared-config/.github/workflows/node-ci.yml@main | |
| with: | |
| node-version: 18.x | |
| working-directory: ./ | |
| run-commit-lint: true | |
| run-build: true | |
| pre-test-script: | | |
| pipx install algokit | |
| algokit localnet start | |
| npx --yes wait-on tcp:4001 -t 30000 | |
| audit-script: | | |
| npm run audit | |
| check_docs: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Clone repository | |
| uses: actions/checkout@v3 | |
| with: | |
| fetch-depth: 1 | |
| - name: Use Node.js 18.x | |
| uses: actions/setup-node@v3 | |
| with: | |
| node-version: 18.x | |
| - name: Check docs are up to date | |
| shell: bash | |
| run: | | |
| npm ci --ignore-scripts | |
| npm run generate:code-docs | |
| # Add untracked files as empty so they come up in diff | |
| git add -N . | |
| # Print changed files and error out if there are changes after generating docs | |
| git diff --exit-code --name-only |