https://github.com/mcandre/mage-extras
some predefined tasks for common mage workflows
https://github.com/mcandre/mage-extras
Last synced: 5 months ago
JSON representation
some predefined tasks for common mage workflows
- Host: GitHub
- URL: https://github.com/mcandre/mage-extras
- Owner: mcandre
- License: other
- Created: 2018-04-01T00:39:23.000Z (about 8 years ago)
- Default Branch: main
- Last Pushed: 2025-07-01T00:07:49.000Z (12 months ago)
- Last Synced: 2025-07-01T01:24:06.412Z (12 months ago)
- Language: Go
- Size: 3.26 MB
- Stars: 5
- Watchers: 2
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# mage-extras: some predefined tasks for common mage workflows
[](https://mcandre.gumroad.com/)
# SUMMARY
mage-extras provides a collection of prebaked tasks for common Go project software development needs.
# EXAMPLE
```console
$ mage noVendor
/Users/andrew/go/src/github.com/mcandre/mage-extras/test.go
/Users/andrew/go/src/github.com/mcandre/mage-extras/mageextras_test.go
/Users/andrew/go/src/github.com/mcandre/mage-extras/errcheck.go
/Users/andrew/go/src/github.com/mcandre/mage-extras/sources.go
/Users/andrew/go/src/github.com/mcandre/mage-extras/gox.go
/Users/andrew/go/src/github.com/mcandre/mage-extras/nakedret.go
/Users/andrew/go/src/github.com/mcandre/mage-extras/vet.go
/Users/andrew/go/src/github.com/mcandre/mage-extras/goimports.go
/Users/andrew/go/src/github.com/mcandre/mage-extras/mageextras.go
/Users/andrew/go/src/github.com/mcandre/mage-extras/packages.go
/Users/andrew/go/src/github.com/mcandre/mage-extras/pathseparator.go
/Users/andrew/go/src/github.com/mcandre/mage-extras/binaries_test.go
/Users/andrew/go/src/github.com/mcandre/mage-extras/sources_test.go
/Users/andrew/go/src/github.com/mcandre/mage-extras/binaries.go
/Users/andrew/go/src/github.com/mcandre/mage-extras/install.go
```
# ABOUT
mage-extras defines some reusable task predicates for common workflows, in a platform-agnostic way:
* security audits
* checking that Go source code actually compiles
* running unit tests
* generating code coverage reports
* linting with assorted Go linting tools
* formatting Go code
* installing and uninstall Go applications
* collecting Go source file paths
* obtaining the GOPATH/bin directory
* referencing all local Go packages
* referencing all local Go commands
* cross-compiling applications with factorio, gox, goxcart, and xgo
* archiving artifacts
* manipulating the path separator as a string
Mage is highly agnostic about workflows. mage-extras is a little more opinionated, introducing some useful conventions on top, such as reliably obtaining a list of non-vendored Go files paths, while allowing developers to customize builds to suit their project needs.
# DOCUMENTATION
https://pkg.go.dev/github.com/mcandre/mage-extras
# LICENSE
BSD-2-Clause
# RUNTIME REQUIREMENTS
* [Go](https://go.dev/) 1.25.4+
* [Mage](https://magefile.org/) (e.g., `go get -tool github.com/magefile/mage`)
## Recommended
* a UNIX environment, such as macOS, Linux, BSD, [WSL](https://learn.microsoft.com/en-us/windows/wsl/), etc.
* [GNU](https://www.gnu.org/software/tar/)/[BSD](https://man.freebsd.org/cgi/man.cgi?tar(1))/[Windows](https://ss64.com/nt/tar.html) tar with gzip support
* [tree](https://linux.die.net/man/1/tree)
tar is a portable archiver suitable for creating `*.tgz` tarball archives. Users can then download the tarball and extract the executable relevant to their platform. Tarballs are especially well suited for use in Docker containers, as the tar command is more likely to be installed than unzip.
Note that non-UNIX file systems may not preserve crucial chmod acl bits during port generation. This can corrupt downstream artifacts, such as compressed archives and installation procedures.
# CONTRIBUTING
For more details on developing mage-extras itself, see [DEVELOPMENT.md](DEVELOPMENT.md).