Categorygithub.com/mcandre/mage-extras
repositorypackage
0.0.26
Repository: https://github.com/mcandre/mage-extras.git
Documentation: pkg.go.dev
Overview
Dependencies
9
Dependents
0

# README

mage-extras: some predefined tasks for common mage workflows

EXAMPLE

$ 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/gofmt.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 1.24.5+
  • Mage (e.g., go get -tool github.com/magefile/mage)

Recommended

  • POSIX compatible tar
  • tree
  • a UNIX environment, such as macOS, Linux, BSD, WSL, etc.

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.