diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-14 00:11:56 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-14 00:11:56 +0300 |
| commit | cfc575a1f13b3442e02ac6be133608139b0236f1 (patch) | |
| tree | 96286eb33e0bfc16611790a99a52d5198250d0f2 /.github/workflows | |
| parent | 6b02343f9cbb1295875c067159cb8a764abbf433 (diff) | |
| download | vyos-documentation-cfc575a1f13b3442e02ac6be133608139b0236f1.tar.gz vyos-documentation-cfc575a1f13b3442e02ac6be133608139b0236f1.zip | |
ci: inline doc-linter on sagitta to match rolling
The lint workflow on this branch referenced
`vyos/.github/.github/workflows/lint-doc.yml@feature/T6349-reusable-workflows`,
which doesn't exist in `vyos/.github` (no commit found for that ref).
The reusable-workflow `uses:` line has been silently failing
(no `doc-lint` check on recent sagitta PRs).
Mirror rolling's approach (inlined 2026-05-10):
- Add `scripts/doc-linter.py` in this repo. Sourced from PR #2014's
HEAD on rolling (the version that includes the `is_docs_path()`
docs/-only scope guard so repo-root meta files like AGENTS.md and
README.md are out of scope, plus the realpath / narrow-exception /
Ruff fixes from that PR's review pass).
- Replace `.github/workflows/lint-doc.yml` with an in-repo workflow
that runs `python scripts/doc-linter.py "$FILES_MODIFIED"` against
the changed-file list from `trilom/file-changes-action`. Same job
shape as rolling.
- Update the `## Lint` and `## CI` bullets in AGENTS.md to point at
the in-repo paths.
This restores actual lint coverage on sagitta PRs and keeps the
toolchain identical across rolling / circinus / sagitta. Behavior on
the 2 remaining `.rst` pages (cli.rst, aws.rst) is unchanged — the
linter's SUPPORTED_EXTS already covers `.md`, `.rst`, and `.txt`.
🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to '.github/workflows')
| -rw-r--r-- | .github/workflows/lint-doc.yml | 34 |
1 files changed, 29 insertions, 5 deletions
diff --git a/.github/workflows/lint-doc.yml b/.github/workflows/lint-doc.yml index 7f2f2099..d7f25f38 100644 --- a/.github/workflows/lint-doc.yml +++ b/.github/workflows/lint-doc.yml @@ -2,9 +2,33 @@ name: Lint Doc on: pull_request: +permissions: + contents: read + pull-requests: read + jobs: - lint-doc: - uses: vyos/.github/.github/workflows/lint-doc.yml@feature/T6349-reusable-workflows - secrets: inherit - - + doc-lint: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v6 + + - name: Bullfrog Secure Runner + continue-on-error: true + uses: bullfrogsec/bullfrog@v0.8.4 + with: + egress-policy: audit + + - name: Get File Changes + id: file_changes + uses: trilom/file-changes-action@v1.2.4 + + - name: Set up Python + uses: actions/setup-python@v6 + with: + python-version: '3.x' + + - name: run doc linter + env: + FILES_MODIFIED: ${{ steps.file_changes.outputs.files_modified }} + run: python scripts/doc-linter.py "$FILES_MODIFIED" |
