Add WORKFLOW.md flow diagrams + doc-accuracy fixes#227
Merged
Conversation
…ide; action-pin uses-ref scope Add Mermaid flow diagrams to WORKFLOW.md and fix doc-accuracy issues found while drawing them (tri-validating each diagram against the prose and the workflow YAML). Diagrams render natively on GitHub. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates WORKFLOW.md to better document the repository’s CI/CD and automation behavior by adding Mermaid flow diagrams and tightening a few “doc vs YAML” accuracy points (action pinning scope, concurrency overrides).
Changes:
- Add three Mermaid flow diagrams covering PR CI (
test-pull-request.yml), publishing (publish-release.yml->build-release-task.yml), and automation (codegen + Dependabot + merge-bot). - Clarify that the SHA-pinning rule applies specifically to
uses:action references (not runtime-downloaded tools). - Document the additional concurrency override for the daily periodic codegen workflow and reflect it in the D7.1 contract text.
This was referenced Jul 9, 2026
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 Mermaid flow diagrams (CI / publish / automation) to
WORKFLOW.md, plus doc-accuracy fixes surfaced by tri-validating the diagrams against the workflow YAML: add flow diagrams; document codegen concurrency override; action-pin uses-ref scope.markdownlint clean, all Mermaid blocks render, CRLF preserved.
🤖 Generated with Claude Code