docs: split Reusable Workflow Templates into per-workflow pages#55
Conversation
`docs/workflows.md` had grown to ~436 lines covering five distinct reusable workflows plus shared sections. Split it so each workflow lives on its own page under `docs/workflows/`, while the index page keeps the intro, the "Why two workflow locations?" explainer, "Updating templates", and the generic troubleshooting tips. - Index page lists each workflow with a one-liner and a link. - `mkdocs.yml` gains a `Workflows` nav group with the index plus the five sub-pages. - `docs/github-actions-pinning.md` anchor links now point at `workflows/pinact-check.md`. Refs #54
|
Warning Review limit reached
More reviews will be available in 10 minutes and 33 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (8)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Secret Leak CheckOK No secrets detected in this PR's diff. |
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the reusable workflow documentation by splitting the previously long docs/workflows.md into an index page plus one page per workflow, and wires the new structure into the MkDocs navigation.
Changes:
- Adds a
Workflowsnav group inmkdocs.ymllinking the index plus five per-workflow pages. - Converts
docs/workflows.mdinto an index page that links out to the new per-workflow docs underdocs/workflows/. - Updates
docs/github-actions-pinning.mdto point to the new Action Pinning Check page location.
Reviewed changes
Copilot reviewed 8 out of 8 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Adds a Workflows nav group with index + five sub-pages. |
| docs/workflows.md | Becomes a short index page with links to per-workflow pages and shared sections retained. |
| docs/workflows/publish-techdocs.md | New per-workflow page for Publish TechDocs (includes its troubleshooting subsection). |
| docs/workflows/release-on-tag.md | New per-workflow page for Release on Tag. |
| docs/workflows/bumblebee-scan.md | New per-workflow page for Bumblebee Supply-Chain Scan. |
| docs/workflows/pinact-check.md | New per-workflow page for Action Pinning Check. |
| docs/workflows/cdk-deploy-monitor.md | New per-workflow page for CDK Deploy Monitor (with detailed reference/troubleshooting). |
| docs/github-actions-pinning.md | Updates internal links to point to workflows/pinact-check.md instead of old anchors in workflows.md. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…ws index Per Copilot review on #55: the "Template" column should match the `workflow-templates/` filenames. Drop the `reusable-` prefix for Bumblebee, pinact-check, and cdk-deploy-monitor rows so the column is internally consistent and accurately points at the file shown in GitHub's "New workflow" picker.
Secret Leak CheckOK No secrets detected in this PR's diff. |
Summary
docs/workflows.mdwas ~436 lines covering five distinct reusable workflows plus shared sections. Split each workflow into its own page underdocs/workflows/.mkdocs.ymlgains aWorkflowsnav group with the index plus the five sub-pages.docs/github-actions-pinning.mdanchor links now point at the newworkflows/pinact-check.mdpage.Closes #54
Test plan
mkdocs build --strictpasses locally with no broken internal linksWorkflowsgroup with all five sub-pages (after merge / on a staging publish)Notes
workflows.md#...anchors are not preserved (out of scope per the issue). The index page still lists each workflow by name.