docs(#5521): add CI workflow conventions guide - #5523
Conversation
Create docs/contributing/ci-workflows.md covering concurrency group patterns, timeout policy, trigger completeness (merge_group), checkout SHA pinning, reusable workflow contracts, permissions, and additional conventions. Uses checklist format for reliable agent consumption during review. Add a row to the AGENTS.md topic-specific guidance table linking the new doc for .github/workflows/ changes. Conventions are derived from patterns already established in the repo's existing workflows (e2e.yml, functional-tests.yml, mint-cf-worker-test.yml) and from review feedback on PR #5482 that caught a redundant concurrency prefix, missing timeout-minutes, and missing merge_group trigger. Note: pre-commit could not run in sandbox (network restriction on git fetch). The post-script runs pre-commit authoritatively on the runner. Closes #5521
|
🤖 Finished Review · ✅ Success · Started 10:14 AM UTC · Completed 10:30 AM UTC |
Site previewPreview: https://823c6d9f-site.fullsend-ai.workers.dev Commit: |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
ReviewFindingsMedium
Low
Labels: PR adds CI workflow conventions documentation under docs/contributing/ and registers it in AGENTS.md |
|
/fs-fix do not use a checklist format. |
|
🤖 Finished Fix · ✅ Success · Started 7:33 AM UTC · Completed 7:37 AM UTC |
Convert all `- [ ]` checkbox items to regular `- ` bullet points in ci-workflows.md and update the intro text from "checklist" to "conventions" to match the style used by other contributing guides. Addresses review feedback on #5523
🔧 Fix agent — iteration 1 (human-triggered)Replaced checklist format with plain bullet points per human instruction. All Fixed (1):
Tests: passed Updated by fullsend fix agent |
|
🤖 Finished Retro · ✅ Success · Started 7:50 AM UTC · Completed 8:01 AM UTC |
Retro: PR #5523 — CI workflow conventions guideWorkflow: Issue #5521 (filed by retro agent from PR #5482) → triage → code → PR #5523 → review → human fix request → fix → human approval → merged. What went well:
What needed rework:
Unresolved finding merged:
Existing issues with new evidence:
Proposals filed
|
Summary
Add
docs/contributing/ci-workflows.mdto document CI workflow conventions that currently exist only as tribal knowledge. Register it in the AGENTS.md topic-specific guidance table so the review agent references these conventions when reviewing.github/workflows/changes.Related Issue
Closes #5521
Changes
docs/contributing/ci-workflows.mdcovering all 5 convention areas from the issue:${{ github.workflow }}, avoid redundant hardcoded prefixes)timeout-minutes)merge_group:on path-filtered workflows with path-relevance guard)pinactfor verification)CI Workflows | Adding or modifying GitHub Actions workflows under .github/workflows/Testing
make lint-md-linkspasses — all links in new doc resolvedocs/contributing/viagetMarkdownFiles()— no manual config neededChecklist
!for breaking changes)Closes #5521
Post-script verification
agent/5521-ci-workflow-conventions)054111862bdd61201a722bc4c28f3fa0c382bdcf..HEAD)