BUILD-11462: Add README for update-release-channel action#277
Conversation
There was a problem hiding this comment.
Pull request overview
Adds end-user documentation for the update-release-channel GitHub Action and extends supported release channels to include dogfood, keeping the action’s validation and docs in sync.
Changes:
- Added
update-release-channel/README.mddocumenting usage patterns, required permissions, and inputs/outputs. - Extended the channel allowlist to accept
dogfood(script validation + action input description + docs). - Added a top-level README section linking to the action’s full reference and providing usage snippets.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
update-release-channel/update-release-channel.sh |
Extends channel validation regex to include dogfood. |
update-release-channel/README.md |
New detailed action documentation (requirements, usage patterns, inputs/outputs). |
update-release-channel/action.yml |
Updates the channel input description to include dogfood. |
README.md |
Adds the action to the repository index and documents it at the top level. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
dcf51eb to
a723892
Compare
julien-carsique-sonarsource
left a comment
There was a problem hiding this comment.
Why a duplicated README in update-release-channel?
The other sub-actions have no README. I would remove it, unless there is additional information for development for instance.
a723892 to
1671bee
Compare
…EADME - Restructure update-release-channel/README.md to mirror other actions: H2 sections (Requirements/Usage/Inputs/Outputs), H3 subsections, Required GitHub Permissions / Vault Permissions / Other Dependencies. - Add update-release-channel to the actions list and full reference section in the root README, linking to update-release-channel/README.md for operational recipes and limitations.
1671bee to
3258541
Compare
|
Code Review ✅ ApprovedDocumentation for the update-release-channel action has been added, and the allowed release channels extended to include 'dogfood'. No issues were found. OptionsAuto-apply is off → Gitar will not commit updates to this branch. Comment with these commands to change:
Was this helpful? React with 👍 / 👎 | Gitar |



BUILD-11462
Adds
update-release-channel/README.mddocumenting the action: inputs/outputs, the two adoption patterns (release-workflow follow-up job and standaloneworkflow_dispatch), the required GitHub Environment with reviewer gate, operational recipes (rollback, delayed promotion, backfill, channel migration), and the publish-vs-promote atomicity caveat with recovery procedure.Also extends the channel allowlist to include
dogfood, solatest | stable | beta | rc | dogfoodare all accepted (script regex + action input description + README updated together). This is needed for thesonarqube-cliadoption (SonarSource/sonarqube-cli#336).