ci: check that referenced ably.com doc links and their anchors still resolve #3

	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:
	# Submodules are needed because `npm ci` runs the `prepare` script, and the build
	# type-checks test sources that import from test/common/ably-common.
	- uses: actions/checkout@f43a0e5ff2bd294095638e18286ca9a3d1956744 # v3
	with:
	submodules: 'recursive'
	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

Navigation Menu