Skip to content

feat: add pull-request check with check-docs action - #4

Merged
oto-macenauer-absa merged 1 commit into
masterfrom
feat/pr-check-docs
Sep 23, 2026
Merged

oto-macenauer-absa merged 1 commit into
masterfrom
feat/pr-check-docs

Conversation

@oto-macenauer-absa

Copy link
Copy Markdown
Collaborator

What

  • Add .github/workflows/check-docs.yml: on pull_request, same checkout / setup-python 3.12 / pack.py --headless build as pack.yml, then AbsaOSS/knowledge-base/actions/check-docs@v1 (manifest: kb-docs.json, dist: dist, strict off). permissions: contents: read. Kept minimal and commented like pack.yml, since this file will be copied.
  • Mention the PR check in README.md (file table + "Publishing a release") and CLAUDE.md.

Test

Local preview with the same checker:

python scripts/pack.py --headless
node ../knowledge-base/actions/lib/check-cli.js --manifest kb-docs.json --dist dist

Result: 0 errors, 1 warning, so this PR's own check should pass.

  • KB-CSS-001 user-guide/docs/style.css: 3 !important declarations.

Follow-up (not fixed here)

  • Remove the 3 !important declarations from theme/style.css (raise specificity instead).

🤖 Generated with Claude Code

Runs the knowledge base contract checks (actions/check-docs@v1) on every
pull request against the same headless build pack.yml publishes, so a
finding that would fail the release fails the PR first.

Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
@oto-macenauer-absa
oto-macenauer-absa merged commit 19ccbca into master Sep 23, 2026
1 check passed
@oto-macenauer-absa
oto-macenauer-absa deleted the feat/pr-check-docs branch September 23, 2026 10:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants