Rearrange README.md, add advanced-usage.md#724
Merged
HarithaVattikuti merged 3 commits intoactions:mainfrom Feb 26, 2026
Merged
Rearrange README.md, add advanced-usage.md#724HarithaVattikuti merged 3 commits intoactions:mainfrom
HarithaVattikuti merged 3 commits intoactions:mainfrom
Conversation
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the action’s documentation by streamlining README.md to focus on core usage and moving advanced examples into a new docs/advanced-usage.md guide.
Changes:
- Added a new advanced usage guide documenting version selection, caching scenarios, outputs, and GHES guidance.
- Restructured
README.mdto emphasize core usage, version resolution behavior, and link out to advanced examples. - Added/updated documentation sections around v6 breaking changes and caching behavior.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/advanced-usage.md | New advanced documentation page containing detailed workflow examples and scenarios. |
| README.md | Reorganized to focus on core usage and reference the new advanced guide. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
priya-kinthali
approved these changes
Feb 26, 2026
gowridurgad
approved these changes
Feb 26, 2026
HarithaVattikuti
approved these changes
Feb 26, 2026
5 tasks
raeperd
added a commit
to raeperd/setup-go
that referenced
this pull request
Mar 25, 2026
Follows the pattern from actions#724 where detailed usage docs live in docs/advanced-usage.md rather than README.md.
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.
Description:
This PR reorganizes the documentation by restructuring
README.mdto focus on core usage, and creates a newadvanced-usage.mdfile to document advanced examples and scenarios.Check list: