Rearrange README.md, add advanced-usage.md#724
Merged
HarithaVattikuti merged 3 commits intoFeb 26, 2026
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.
hoodnoah
added a commit
to hoodnoah/certmanager-porkbun-webhook
that referenced
this pull request
Jun 10, 2026
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [actions/setup-go](https://github.com/actions/setup-go) | action | major | `v5` → `v6` | --- ### Release Notes <details> <summary>actions/setup-go (actions/setup-go)</summary> ### [`v6.4.0`](https://github.com/actions/setup-go/releases/tag/v6.4.0) [Compare Source](actions/setup-go@v6.3.0...v6.4.0) ##### What's Changed ##### Enhancement - Add go-download-base-url input for custom Go distributions by [@​gdams](https://github.com/gdams) in [#​721](actions/setup-go#721) ##### Dependency update - Upgrade minimatch from 3.1.2 to 3.1.5 by [@​dependabot](https://github.com/dependabot) in [#​727](actions/setup-go#727) ##### Documentation update - Rearrange README.md, add advanced-usage.md by [@​priyagupta108](https://github.com/priyagupta108) in [#​724](actions/setup-go#724) - Fix Microsoft build of Go link by [@​gdams](https://github.com/gdams) in [#​734](actions/setup-go#734) ##### New Contributors - [@​gdams](https://github.com/gdams) made their first contribution in [#​721](actions/setup-go#721) **Full Changelog**: <actions/setup-go@v6...v6.4.0> ### [`v6.3.0`](https://github.com/actions/setup-go/releases/tag/v6.3.0) [Compare Source](actions/setup-go@v6.2.0...v6.3.0) ##### What's Changed - Update default Go module caching to use go.mod by [@​priyagupta108](https://github.com/priyagupta108) in [#​705](actions/setup-go#705) - Fix golang download url to go.dev by [@​178inaba](https://github.com/178inaba) in [#​469](actions/setup-go#469) **Full Changelog**: <actions/setup-go@v6...v6.3.0> ### [`v6.2.0`](https://github.com/actions/setup-go/releases/tag/v6.2.0) [Compare Source](actions/setup-go@v6.1.0...v6.2.0) ##### What's Changed ##### Enhancements - Example for restore-only cache in documentation by [@​aparnajyothi-y](https://github.com/aparnajyothi-y) in [#​696](actions/setup-go#696) - Update Node.js version in action.yml by [@​ccoVeille](https://github.com/ccoVeille) in [#​691](actions/setup-go#691) - Documentation update of actions/checkout by [@​deining](https://github.com/deining) in [#​683](actions/setup-go#683) ##### Dependency updates - Upgrade js-yaml from 3.14.1 to 3.14.2 by [@​dependabot](https://github.com/dependabot) in [#​682](actions/setup-go#682) - Upgrade [@​actions/cache](https://github.com/actions/cache) to v5 by [@​salmanmkc](https://github.com/salmanmkc) in [#​695](actions/setup-go#695) - Upgrade actions/checkout from 5 to 6 by [@​dependabot](https://github.com/dependabot) in [#​686](actions/setup-go#686) - Upgrade qs from 6.14.0 to 6.14.1 by [@​dependabot](https://github.com/dependabot) in [#​703](actions/setup-go#703) ##### New Contributors - [@​ccoVeille](https://github.com/ccoVeille) made their first contribution in [#​691](actions/setup-go#691) - [@​deining](https://github.com/deining) made their first contribution in [#​683](actions/setup-go#683) **Full Changelog**: <actions/setup-go@v6...v6.2.0> ### [`v6.1.0`](https://github.com/actions/setup-go/releases/tag/v6.1.0) [Compare Source](actions/setup-go@v6...v6.1.0) ##### What's Changed ##### Enhancements - Fall back to downloading from go.dev/dl instead of storage.googleapis.com/golang by [@​nicholasngai](https://github.com/nicholasngai) in [#​665](actions/setup-go#665) - Add support for .tool-versions file and update workflow by [@​priya-kinthali](https://github.com/priya-kinthali) in [#​673](actions/setup-go#673) - Add comprehensive breaking changes documentation for v6 by [@​mahabaleshwars](https://github.com/mahabaleshwars) in [#​674](actions/setup-go#674) ##### Dependency updates - Upgrade eslint-config-prettier from 10.0.1 to 10.1.8 and document breaking changes in v6 by [@​dependabot](https://github.com/dependabot) in [#​617](actions/setup-go#617) - Upgrade actions/publish-action from 0.3.0 to 0.4.0 by [@​dependabot](https://github.com/dependabot) in [#​641](actions/setup-go#641) - Upgrade semver and [@​types/semver](https://github.com/types/semver) by [@​dependabot](https://github.com/dependabot) in [#​652](actions/setup-go#652) ##### New Contributors - [@​nicholasngai](https://github.com/nicholasngai) made their first contribution in [#​665](actions/setup-go#665) - [@​priya-kinthali](https://github.com/priya-kinthali) made their first contribution in [#​673](actions/setup-go#673) - [@​mahabaleshwars](https://github.com/mahabaleshwars) made their first contribution in [#​674](actions/setup-go#674) **Full Changelog**: <actions/setup-go@v6...v6.1.0> ### [`v6.0.0`](https://github.com/actions/setup-go/releases/tag/v6.0.0) [Compare Source](actions/setup-go@v6...v6) ##### What's Changed ##### Breaking Changes - Improve toolchain handling to ensure more reliable and consistent toolchain selection and management by [@​matthewhughes934](https://github.com/matthewhughes934) in [#​460](actions/setup-go#460) - Upgrade Nodejs runtime from node20 to node 24 by [@​salmanmkc](https://github.com/salmanmkc) in [#​624](actions/setup-go#624) Make sure your runner is on version v2.327.1 or later to ensure compatibility with this release. [See Release Notes](https://github.com/actions/runner/releases/tag/v2.327.1) ##### Dependency Upgrades - Upgrade [@​types/jest](https://github.com/types/jest) from 29.5.12 to 29.5.14 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​589](actions/setup-go#589) - Upgrade [@​actions/tool-cache](https://github.com/actions/tool-cache) from 2.0.1 to 2.0.2 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​591](actions/setup-go#591) - Upgrade [@​typescript-eslint/parser](https://github.com/typescript-eslint/parser) from 8.31.1 to 8.35.1 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​590](actions/setup-go#590) - Upgrade undici from 5.28.5 to 5.29.0 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​594](actions/setup-go#594) - Upgrade typescript from 5.4.2 to 5.8.3 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​538](actions/setup-go#538) - Upgrade eslint-plugin-jest from 28.11.0 to 29.0.1 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​603](actions/setup-go#603) - Upgrade `form-data` to bring in fix for critical vulnerability by [@​matthewhughes934](https://github.com/matthewhughes934) in [#​618](actions/setup-go#618) - Upgrade actions/checkout from 4 to 5 by [@​dependabot](https://github.com/dependabot)\[bot] in [#​631](actions/setup-go#631) ##### New Contributors - [@​matthewhughes934](https://github.com/matthewhughes934) made their first contribution in [#​618](actions/setup-go#618) - [@​salmanmkc](https://github.com/salmanmkc) made their first contribution in [#​624](actions/setup-go#624) **Full Changelog**: <actions/setup-go@v5...v6.0.0> ### [`v6`](actions/setup-go@v5.6.0...v6) [Compare Source](actions/setup-go@v5.6.0...v6) </details> --- ### Configuration 📅 **Schedule**: (UTC) - Branch creation - At any time (no schedule defined) - Automerge - At any time (no schedule defined) 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0My4yMTcuMSIsInVwZGF0ZWRJblZlciI6IjQzLjIxNy4xIiwidGFyZ2V0QnJhbmNoIjoibWFpbiIsImxhYmVscyI6W119--> Co-authored-by: hoodn <[email protected]> Reviewed-on: https://gitea.k3s.noah-hood.io/hoodn/certmanager-porkbun-webhook/pulls/7 Co-authored-by: renovate-bot <[email protected]> Co-committed-by: renovate-bot <[email protected]>
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: