docs: document immutable release model and correct branch reference - #640
Open
MaddyMicrosoft wants to merge 1 commit into
Open
docs: document immutable release model and correct branch reference#640MaddyMicrosoft wants to merge 1 commit into
MaddyMicrosoft wants to merge 1 commit into
Conversation
- Add a 'Release integrity' section explaining immutable releases: exact version tags are frozen, built artifacts live on release refs (not master), and the major tag floats forward to published release commits. - Correct the 'Branch reference' section: @master is not consumable because the compiled lib/ is not committed to master, so it would fail to run. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
MaddyMicrosoft
requested a deployment
to
Automation test
September 7, 2026 00:03 — with
GitHub Actions
Waiting
MaddyMicrosoft
requested a deployment
to
Automation test
September 7, 2026 00:03 — with
GitHub Actions
Waiting
MaddyMicrosoft
requested a deployment
to
Automation test
September 7, 2026 00:03 — with
GitHub Actions
Waiting
MaddyMicrosoft
requested a deployment
to
Automation test
September 7, 2026 00:03 — with
GitHub Actions
Waiting
MaddyMicrosoft
requested a deployment
to
Automation test
September 7, 2026 00:03 — with
GitHub Actions
Waiting
MaddyMicrosoft
requested a deployment
to
Automation test
September 7, 2026 00:03 — with
GitHub Actions
Waiting
MaddyMicrosoft
requested a deployment
to
Automation test
September 7, 2026 00:03 — with
GitHub Actions
Waiting
MaddyMicrosoft
requested a deployment
to
Automation test
September 7, 2026 00:03 — with
GitHub Actions
Waiting
MaddyMicrosoft
requested a deployment
to
Automation test
September 7, 2026 00:03 — with
GitHub Actions
Waiting
MaddyMicrosoft
requested a deployment
to
Automation test
September 7, 2026 00:03 — with
GitHub Actions
Waiting
MaddyMicrosoft
requested a deployment
to
Automation test
September 7, 2026 00:03 — with
GitHub Actions
Waiting
MaddyMicrosoft
marked this pull request as ready for review
September 7, 2026 00:03
Copilot started reviewing on behalf of
Teresa Ritorto (teresaritorto)
September 7, 2026 00:36
View session
Teresa Ritorto (teresaritorto)
approved these changes
Sep 7, 2026
There was a problem hiding this comment.
🟡 Changes recommended
The “Branch reference” section still presents a copy/pasteable @master example, which undermines the goal of steering consumers away from branch refs.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
This PR updates consumer-facing documentation in README.md to describe the repository’s immutable release model and to clarify that branch refs (like the default branch) are not supported for action consumption because built artifacts are published only on release refs.
Changes:
- Added a new Release integrity section describing immutable exact-version tags and the intentionally floating major tag (
v3). - Replaced the prior “branch reference” guidance with a warning that
@master(and other branch refs) are not runnable becauselib/isn’t present there. - Updated the table of contents to include the new section.
File summaries
| File | Description |
|---|---|
| README.md | Adds “Release integrity” documentation and corrects branch-ref consumption guidance to point users to tags/SHA. |
Review details
Suppressed comments (1)
README.md:112
- After changing the code-block example away from
@master, the warning text should also be updated so it doesn’t imply only@masteris the problematic case; any branch ref (including the default branch) is non-consumable becauselib/isn’t present there.
> Branch references such as `@master` are **not** supported for consumption. The action's compiled output (`lib/`) is not committed to `master`; it is built and published only to release tags and `releases/*` branches, so referencing `@master` will fail to run. Use a major-version tag, an exact version tag, or a full-length commit SHA instead.
- Files reviewed: 1/1 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| @@ -107,7 +108,8 @@ Remains pinned to that specific release and does not automatically receive futur | |||
| uses: azure/login@master | |||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the immutable release model for consumers and fixes a misleading reference in the README.
Changes
lib/lives on release tags/branches (notmaster), andv3is the one intentionally-floating pointer that only ever advances to published release commits. Recommends SHA-pinning for supply-chain hardening.uses: azure/login@masterwas documented as usable, butmastercontains source only (lib/is gitignored and built only onto release refs), so it would fail to run. Replaced with a warning pointing to tags/SHA.Notes