Repository navigation
feat: docs-check.yml, docsync and otfabric-policy on every push - #17
Merged
Merged
Conversation
A reusable workflow for the check that runs when the heavy workflows skip a Markdown-only change: docsync (enforce or warn) and otfabric-policy. The workflows README documents paths-ignore for the heavy workflows and why branch protection must require the Docs check. Two selftest cases. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
go run turns every exit code into 1, and GitHub's bash runs with -e, so the warn mode failed. docs-check.sh runs the step on the fixtures: enforce fails on a finding, warn passes, a bad mode exits 2. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds the reusable
docs-check.yml: docsync v0.1.0 checks that a module's documents agree with its code, and otfabric-policy runs as ingo-ci.yml. It is cheap and has no path filter, so it reports on Markdown-only pushes, which the heavy workflows will skip withpaths-ignore: ['**/*.md'].mode: enforce(default) orwarn; a docsync error (exit 2+) fails in both..github/workflows/README.md: a section on Markdown-only changes, the caller template, inputs, and the rule that branch protection requires Docs/Policy, never a path-filtered workflow.docs-check-pass(enforce, policy on) anddocs-check-warn(a fixture with one finding, warn mode).Not in this PR: SAST was removed on main after v3.4.0 (#16). v3.4.0's
go-ci.ymlcalls./.github/workflows/sast.yml, which resolves in the caller's repository, so no external caller of v3.4.0 starts (seen on otfabric/docsync). The next tag, v3.5.0, carries that removal too.🤖 Generated with Claude Code