mirror of
https://github.com/tiennm99/ccs.git
synced 2026-10-04 14:13:13 +00:00
56 lines
1.7 KiB
YAML
56 lines
1.7 KiB
YAML
name: Docs – Parity and Freshness
|
||
|
||
on:
|
||
push:
|
||
paths:
|
||
- 'docs/quickstart-snippet.md'
|
||
- 'README.md'
|
||
- 'docker/README.md'
|
||
- 'macos-bar/README.md'
|
||
- 'docs/**'
|
||
- '.github/ISSUE_TEMPLATE/**'
|
||
- 'src/**'
|
||
- 'scripts/hardening-inventory.js'
|
||
- 'scripts/maintainability-metrics.js'
|
||
- 'scripts/runtime-source-classifier.js'
|
||
- 'tests/docs/quickstart-parity.sh'
|
||
- 'tests/docs/documentation-freshness.js'
|
||
- '.github/workflows/docs-parity.yml'
|
||
pull_request:
|
||
paths:
|
||
- 'docs/quickstart-snippet.md'
|
||
- 'README.md'
|
||
- 'docker/README.md'
|
||
- 'macos-bar/README.md'
|
||
- 'docs/**'
|
||
- '.github/ISSUE_TEMPLATE/**'
|
||
- 'src/**'
|
||
- 'scripts/hardening-inventory.js'
|
||
- 'scripts/maintainability-metrics.js'
|
||
- 'scripts/runtime-source-classifier.js'
|
||
- 'tests/docs/quickstart-parity.sh'
|
||
- 'tests/docs/documentation-freshness.js'
|
||
- '.github/workflows/docs-parity.yml'
|
||
|
||
jobs:
|
||
docs-parity:
|
||
name: Assert documentation parity and freshness
|
||
if: >-
|
||
contains(fromJSON('["COLLABORATOR","MEMBER","OWNER"]'), github.event.pull_request.author_association)
|
||
|| github.event_name == 'push'
|
||
runs-on: [self-hosted, linux, x64, cliproxy]
|
||
steps:
|
||
- name: Checkout
|
||
uses: actions/checkout@v4
|
||
with:
|
||
persist-credentials: false
|
||
|
||
- name: Run quickstart parity check
|
||
run: bash tests/docs/quickstart-parity.sh
|
||
|
||
- name: Validate documentation pointers and relative links
|
||
run: node tests/docs/documentation-freshness.js
|
||
|
||
- name: Validate generated hardening inventory
|
||
run: node scripts/hardening-inventory.js --check
|