Skip to content

BUILD-11462: Add README for update-release-channel action#277

Merged
jayadeep-km-sonarsource merged 4 commits into
masterfrom
feat/jkinavoormadam/BUILD-11462-actionReadme
Jun 2, 2026
Merged

BUILD-11462: Add README for update-release-channel action#277
jayadeep-km-sonarsource merged 4 commits into
masterfrom
feat/jkinavoormadam/BUILD-11462-actionReadme

Conversation

@jayadeep-km-sonarsource
Copy link
Copy Markdown
Contributor

@jayadeep-km-sonarsource jayadeep-km-sonarsource commented May 28, 2026

BUILD-11462

Adds update-release-channel/README.md documenting the action: inputs/outputs, the two adoption patterns (release-workflow follow-up job and standalone workflow_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, so latest | stable | beta | rc | dogfood are all accepted (script regex + action input description + README updated together). This is needed for the sonarqube-cli adoption (SonarSource/sonarqube-cli#336).

@hashicorp-vault-sonar-prod
Copy link
Copy Markdown

hashicorp-vault-sonar-prod Bot commented May 28, 2026

BUILD-11462

Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.md documenting 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.

Comment thread update-release-channel/update-release-channel.sh
Comment thread update-release-channel/update-release-channel.sh
@jayadeep-km-sonarsource jayadeep-km-sonarsource force-pushed the feat/jkinavoormadam/BUILD-11462-actionReadme branch from dcf51eb to a723892 Compare June 2, 2026 07:47
@jayadeep-km-sonarsource jayadeep-km-sonarsource enabled auto-merge (squash) June 2, 2026 07:49
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Comment thread update-release-channel/README.md Outdated
Comment thread update-release-channel/README.md Outdated
Comment thread update-release-channel/README.md Outdated
Comment thread update-release-channel/README.md Outdated
@jayadeep-km-sonarsource jayadeep-km-sonarsource force-pushed the feat/jkinavoormadam/BUILD-11462-actionReadme branch from a723892 to 1671bee Compare June 2, 2026 08:24
…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.
@jayadeep-km-sonarsource jayadeep-km-sonarsource force-pushed the feat/jkinavoormadam/BUILD-11462-actionReadme branch from 1671bee to 3258541 Compare June 2, 2026 08:25
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented Jun 2, 2026

@jayadeep-km-sonarsource jayadeep-km-sonarsource merged commit 2e3882b into master Jun 2, 2026
17 checks passed
@jayadeep-km-sonarsource jayadeep-km-sonarsource deleted the feat/jkinavoormadam/BUILD-11462-actionReadme branch June 2, 2026 08:28
@gitar-bot
Copy link
Copy Markdown

gitar-bot Bot commented Jun 2, 2026

Code Review ✅ Approved

Documentation for the update-release-channel action has been added, and the allowed release channels extended to include 'dogfood'. No issues were found.

Options

Auto-apply is off → Gitar will not commit updates to this branch.
Display: compact → Showing less information.

Comment with these commands to change:

Auto-apply Compact
gitar auto-apply:on         
gitar display:verbose         

Was this helpful? React with 👍 / 👎 | Gitar

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants