Skip to content

docs: update refs and clarify versioning details#29323

Merged
mnkiefer merged 2 commits intomainfrom
docs-fix-versioning-guide
Apr 30, 2026
Merged

docs: update refs and clarify versioning details#29323
mnkiefer merged 2 commits intomainfrom
docs-fix-versioning-guide

Conversation

@mnkiefer
Copy link
Copy Markdown
Collaborator

  • Updates guide for organization workflow sharing to clarify guidance around workflow imports, versioning, and update behavior.

Co-authored-by: Copilot <copilot@github.com>
@mnkiefer mnkiefer self-assigned this Apr 30, 2026
@mnkiefer mnkiefer marked this pull request as ready for review April 30, 2026 13:38
Copilot AI review requested due to automatic review settings April 30, 2026 13:38
@mnkiefer mnkiefer merged commit 285a809 into main Apr 30, 2026
@mnkiefer mnkiefer deleted the docs-fix-versioning-guide branch April 30, 2026 13:38
@github-actions github-actions Bot mentioned this pull request Apr 30, 2026
Copy link
Copy Markdown
Contributor

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

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/with imports.
  • 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, but gh aw update applies the same “stay within major unless --major” behavior to any semantic-version ref (e.g., @v1.2.0 as 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

Comment thread docs/src/content/docs/organization-practices/sharing-workflows.md
@github-actions
Copy link
Copy Markdown
Contributor

✅ smoke-ci: safeoutputs CLI comment + comment-memory run (25168598410)

Generated by Smoke CI for issue #29323 ·

@github-actions
Copy link
Copy Markdown
Contributor

Comment Memory

CI lights the path
Green checks bloom at dawn
Quiet bots still sing

Note

This comment is managed by comment memory.

It stores persistent context for this thread in the code block at the top of this comment.
Edit only the text inside the backtick fences; workflow metadata and the footer are regenerated automatically.

Learn more about comment memory

Generated by Smoke CI for issue #29323 ·

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.

2 participants