ci: check that referenced ably.com doc links and their anchors still resolve #1
This file contains hidden or 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: Doc Links | |
| on: | |
| pull_request: | |
| paths: | |
| - 'ably.d.ts' | |
| - 'modular.d.ts' | |
| - 'src/**' | |
| - 'scripts/checkDocLinks.ts' | |
| - '.github/workflows/docs-links.yml' | |
| push: | |
| branches: | |
| - main | |
| # The docs site is restructured independently of this repository, so a link that is | |
| # correct when merged can rot later. The scheduled run catches that drift. | |
| schedule: | |
| - cron: '0 7 * * 1' | |
| workflow_dispatch: | |
| permissions: | |
| contents: read | |
| jobs: | |
| check: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3 | |
| with: | |
| persist-credentials: false | |
| - name: Use Node.js 20.x | |
| uses: actions/setup-node@3235b876344d2a9aa001b8d1453c930bba69e610 # v3 | |
| with: | |
| node-version: 20.x | |
| - name: Install Package Dependencies | |
| run: npm ci | |
| - name: Check documentation links | |
| run: npm run check-doc-links |