Mage Action

GitHub Action for Mage

---

• Usage
• Customizing
  • inputs
• License

Usage

Quick start

name: mage

on:
  pull_request:
  push:

jobs:
  mage:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v4
      -
        name: Set up Go
        uses: actions/setup-go@v4
        with:
          go-version: 1.21
      -
        name: Run Mage
        uses: magefile/mage-action@v3
        with:
          version: latest
          args: build

For detailed instructions please follow GitHub Actions workflow syntax.

Install Only

name: mage

on:
  pull_request:
  push:

jobs:
  mage:
    runs-on: ubuntu-latest
    steps:
      -
        name: Checkout
        uses: actions/checkout@v4
      -
        name: Set up Go
        uses: actions/setup-go@v4
        with:
          go-version: 1.21
      -
        name: Run Mage
        uses: magefile/mage-action@v3
        with:
          install-only: true
      -
        name: Show Mage version
        run: mage --version

Customizing

inputs

Following inputs can be used as step.with keys

Name	Type	Default	Description
version	String	latest	Mage version. Example: v1.9.0
args	String		Arguments to pass to Mage
workdir	String	.	Working directory (below repository root)
install-only	Bool	false	Just install Mage

License

MIT. See LICENSE for more details.