Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 23, 2025

Added documentation for pinning installations to specific versions for reproducible deployments and team consistency.

Changes

  • Extension installation pinning: Document gh extension install --pin flag for release tags and commit SHAs
  • Standalone installer pinning: Document version argument for install-gh-aw.sh script
  • Version management: Added examples for checking current version and upgrading between pinned versions
  • Best practices guidance: When to pin (production, team consistency, testing, avoiding breaking changes)

Example

# Pin gh extension to specific release
gh extension install githubnext/gh-aw --pin v0.33.12

# Pin standalone installer to specific version
curl -sL https://raw.githubusercontent.com/githubnext/gh-aw/main/install-gh-aw.sh | bash -s v0.33.12
Original prompt

Add documentation in cli.md about pinning to a version. Also document install.sh pinning

Custom agent used: technical-doc-writer
AI technical documentation writer for GitHub Actions library using Astro Starlight and GitHub Docs voice


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

- Document gh extension install --pin flag for pinning to specific versions
- Add examples for pinning to release tags and commit SHAs
- Document install-gh-aw.sh version argument
- Include usage examples for both extension and standalone installer
- Add guidance on when to pin versions (production, team consistency, etc.)

Co-authored-by: pelikhan <4175913+pelikhan@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation about pinning versions in cli.md Document version pinning for gh extension install and install-gh-aw.sh Dec 23, 2025
Copilot AI requested a review from pelikhan December 23, 2025 03:43
@pelikhan pelikhan marked this pull request as ready for review December 23, 2025 03:45
@pelikhan pelikhan merged commit 085aa67 into main Dec 23, 2025
4 checks passed
@pelikhan pelikhan deleted the copilot/add-cli-documentation-pinning branch December 23, 2025 03:45
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