https://github.com/magefile/mage-action

GitHub Action for Mage
https://github.com/magefile/mage-action

actions buildscript github-actions golang mage make

Last synced: about 2 months ago
JSON representation

GitHub Action for Mage

• Host: GitHub
• URL: https://github.com/magefile/mage-action
• Owner: magefile
• License: mit
• Created: 2019-09-22T16:16:35.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2024-06-19T12:31:16.000Z (3 months ago)
• Last Synced: 2024-07-18T21:08:51.204Z (2 months ago)
• Topics: actions, buildscript, github-actions, golang, mage, make
• Language: TypeScript
• Homepage: https://github.com/marketplace/actions/mage-action
• Size: 7.48 MB
• Stars: 33
• Watchers: 3
• Forks: 7
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Support: .github/SUPPORT.md

Awesome Lists containing this project

• awesome-ccamel - magefile/mage-action - GitHub Action for Mage (TypeScript)

README

        


  

  
Mage Action

  
GitHub Action for Mage

  


    

    

    

    

    

  


___

![Mage Action](.github/mage-action.png)

* [Usage](#usage)

* [Customizing](#customizing)

  * [inputs](#inputs)

* [License](#license)

## Usage

### Quick start

```yaml

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](https://help.github.com/en/articles/workflow-syntax-for-github-actions#About-yaml-syntax-for-workflows).

### Install Only

```yaml

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.