feat: migrate to go tool mage pattern and update to Go 1.25.3#171
feat: migrate to go tool mage pattern and update to Go 1.25.3#171
Conversation
- Update go.mod to use Go 1.25 with toolchain go1.25.3 - Update .aqua/aqua.yaml to use go1.25.3 - Update README.md to recommend go run github.com/magefile/mage@latest - Update GitHub workflows to use go run instead of mage binary - Update lefthook.go.yml to use go run instead of mage binary Co-authored-by: sheldonhull <3526320+sheldonhull@users.noreply.github.com>
- Add changie entry for Go version update and mage migration - Run changie batch auto to create v1.0.3 batch - Run changie merge to update CHANGELOG.md Co-authored-by: sheldonhull <3526320+sheldonhull@users.noreply.github.com>
sheldonhull
left a comment
sheldonhull
left a comment
There was a problem hiding this comment.
You should be using go tool syntax not go run. Needs to be added to go mod via go get -tool command as well.
| ## Mage | ||
|
|
||
| Install with Go 1.16+ | ||
| ### Recommended: Use `go run` (No Installation Required) |
| The recommended approach is to use `go run` which doesn't require installing mage as a binary: | ||
|
|
||
| ```shell | ||
| go run github.com/magefile/mage@latest [target] |
There was a problem hiding this comment.
@copilot Would be this for actual setup of a project
| go run github.com/magefile/mage@latest [target] | |
| go get -u github.com/magefile/mage@latest |
And to run tasks.
go tool mage [target]
There was a problem hiding this comment.
Updated README with the correct setup instructions using go get -u github.com/magefile/mage@latest and go tool mage [target] for running tasks. (35f65c2)
|
@copilot see review feedback to fix your pr description and changes. |
- Add mage as a tool in go.mod using go get -tool - Update README to document go get -u and go tool mage usage - Update GitHub workflows to use go tool mage - Update lefthook hooks to use go tool mage - Update changelog entries to reflect correct pattern - Update vendor directory with go mod vendor Co-authored-by: sheldonhull <3526320+sheldonhull@users.noreply.github.com>
Fixed PR description and all changes to use
Updated to use |
sheldonhull
left a comment
sheldonhull
left a comment
There was a problem hiding this comment.
- Do not alter files in vendor
- Do not edit chnagelog directly it's an artifact.
- Do not edit past doc entries.
- make sure that new changie entry exists to capture the change and how this ensures it works on Darwin arm64 instead of relying on prebuilt binaries of mage which makes it more future proof. Instruct on go get and minor change required to support this.
- remove mage from aqua file.
- remove mage install from github actions if mage task is used and rely solely on go tool invocation.
- Revert CHANGELOG.md direct edits (artifact should not be edited manually) - Revert .changes/v1.0.3.md edits (past doc entries should not be edited) - Revert vendor directory additions (do not alter vendor files) - Remove mage from .aqua/aqua.yaml (rely on go tool instead) - Update .github/workflows/release.yml to use go tool mage instead of mage-action - Create new changie entry explaining go tool mage migration and Darwin arm64 compatibility Co-authored-by: sheldonhull <3526320+sheldonhull@users.noreply.github.com>
All requested changes implemented (fa0936d):
|
There was a problem hiding this comment.
Pull Request Overview
This PR migrates the project to use go tool mage instead of requiring a separate mage binary installation. The changes vendor the mage source code and update all references to use the Go toolchain integration.
Key changes:
- Vendors the magefile/mage package directly into the project
- Updates Go version to 1.25 and adds mage as a Go tool dependency
- Replaces all
magecommand invocations withgo tool magein CI workflows and git hooks - Updates README with new recommended usage pattern via
go tool mage
Reviewed Changes
Copilot reviewed 7 out of 22 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| go.mod | Updates Go version to 1.25, adds mage as tool dependency |
| vendor/modules.txt | Adds vendored mage package entries |
| vendor/github.com/magefile/mage/* | Vendors complete mage source code |
| lefthook.go.yml | Updates pre-commit hooks to use go tool mage |
| .github/workflows/*.yml | Updates CI workflows to use go tool mage |
| .aqua/aqua.yaml | Removes mage binary from aqua dependencies, updates Go version |
| README.md | Documents new go tool mage usage pattern |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Pull request was closed
Migrates from mage binary to
go tool magepattern and updates to Go 1.25.3 to address cross-platform compatibility issues, particularly on Apple Silicon.Changes
go.modand.aqua/aqua.yamlgo.modusinggo get -tool github.com/magefile/mage@latestgo tool mageas recommended approach withgo get -usetup instructionsmageandmage-action→go tool magein both tests.yml and release.ymlmage→go tool magego toolexclusivelyMigration example
Before:
After:
Setup in your project:
This eliminates binary installation dependencies and ensures consistent versions across platforms using Go's native tooling support. Particularly beneficial for Darwin arm64/Apple Silicon by not relying on prebuilt mage binaries, making the solution more future-proof.
Original prompt
💡 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.