docs: update refs and clarify versioning details#29323
Merged
Conversation
Collaborator
mnkiefer
commented
Apr 30, 2026
- Updates guide for organization workflow sharing to clarify guidance around workflow imports, versioning, and update behavior.
Co-authored-by: Copilot <copilot@github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Updates organization workflow-sharing documentation to refine imports references and clarify how version refs behave when updating shared workflows.
Changes:
- Updates the Imports Reference deep-link for parameterized
uses/withimports. - Reworks the “Versioning and update flow” section to describe different ref types and update behavior.
- Tightens the Organization Practices index blurb for the Sharing Workflows page.
Show a summary per file
| File | Description |
|---|---|
| docs/src/content/docs/organization-practices/sharing-workflows.md | Updates imports link and rewrites versioning/update guidance for shared workflows. |
| docs/src/content/docs/organization-practices/index.mdx | Shortens the Sharing Workflows description to match the page scope. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comments suppressed due to low confidence (1)
docs/src/content/docs/organization-practices/sharing-workflows.md:73
- The text implies the major-version constraint only applies when the recorded
source:uses a moving major ref like@v1, butgh aw updateapplies the same “stay within major unless--major” behavior to any semantic-version ref (e.g.,@v1.2.0as well). Consider rewording this sentence to describe semver refs generally, otherwise it can mislead readers about what happens with fully pinned tags.
Updates use a 3-way merge by default to preserve local edits. Use `--no-merge` to replace the local copy with the upstream version without merging. When the recorded `source:` uses a moving major ref such as `@v1`, `gh aw update` stays within that major line unless `--major` is passed.
- Files reviewed: 2/2 changed files
- Comments generated: 1
Contributor
Contributor
Comment MemoryNote This comment is managed by comment memory.It stores persistent context for this thread in the code block at the top of this comment. |
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.