Conversation
Add a workflow that regenerates README.md after each release using tj-actions/auto-doc, then creates a PR with the updated documentation. This prevents CI failures on subsequent PRs caused by stale version references in the README. Change-Id: Id86dc09a2e74c7b54e9b8418038878dfd3c6955e
Merge ProtectionsYour pull request matches the following merge protections and will not be merged until they are valid. 🔴 🤖 Continuous IntegrationThis rule is failing.
🔴 👀 Review RequirementsThis rule is failing.
🔴 🔎 ReviewsThis rule is failing.
🟢 Enforce conventional commitWonderful, this rule succeeded.Make sure that we follow https://www.conventionalcommits.org/en/v1.0.0/
🟢 📕 PR descriptionWonderful, this rule succeeded.
|
There was a problem hiding this comment.
Pull request overview
Adds a GitHub Actions workflow that automatically regenerates README.md documentation after a release is published and opens a PR with the changes, helping prevent CI failures caused by stale README version references.
Changes:
- Introduces a new
release.published-triggered workflow to runtj-actions/auto-doc. - Automatically opens a PR (branch named from the release tag) containing the regenerated documentation.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| runs-on: ubuntu-24.04 | ||
| steps: | ||
| - name: Checkout | ||
| uses: actions/checkout@v6 |
There was a problem hiding this comment.
actions/checkout is referenced as @v6 here, while the rest of the workflows mostly pin it to the patch version (actions/checkout@v6.0.2, e.g. .github/workflows/ci.yaml:21,74,115,153). Consider pinning this workflow to the same patch version for consistency and more deterministic runs.
| uses: actions/checkout@v6 | |
| uses: actions/checkout@v6.0.2 |
jd
deleted the
devs/jd/ci/autodoc-on-release/Id86dc09a2e74c7b54e9b8418038878dfd3c6955e
branch
Add a workflow that regenerates README.md after each release
using tj-actions/auto-doc, then creates a PR with the updated
documentation. This prevents CI failures on subsequent PRs
caused by stale version references in the README.