67 lines
2.7 KiB
Markdown
67 lines
2.7 KiB
Markdown
[](https://github.com/crazy-max/ghaction-goreleaser/releases/latest)
|
|
[](https://github.com/marketplace/actions/goreleaser-action)
|
|
[](https://github.com/crazy-max/ghaction-goreleaser/actions)
|
|
[](https://www.patreon.com/crazymax)
|
|
[](https://www.paypal.me/crazyws)
|
|
|
|
## ✨ About
|
|
|
|
GitHub Action for [GoReleaser](https://goreleaser.com/), a release automation tool for Go projects.
|
|
|
|
> **:warning: Note:** To use this action, you must have access to the [GitHub Actions](https://github.com/features/actions) feature. GitHub Actions are currently only available in public beta. You can [apply for the GitHub Actions beta here](https://github.com/features/actions/signup/).
|
|
|
|
## 🚀 Usage
|
|
|
|
Below is a simple snippet to use this action. A [live example](https://github.com/crazy-max/ghaction-goreleaser/actions) is also available for this repository.
|
|
|
|
```yaml
|
|
name: goreleaser
|
|
|
|
on:
|
|
pull_request:
|
|
push:
|
|
|
|
jobs:
|
|
goreleaser:
|
|
runs-on: ubuntu-latest
|
|
steps:
|
|
-
|
|
name: Checkout
|
|
uses: actions/checkout@master
|
|
-
|
|
name: Set up Go
|
|
uses: actions/setup-go@master
|
|
-
|
|
name: Run GoReleaser
|
|
uses: crazy-max/ghaction-goreleaser@master
|
|
with:
|
|
version: latest
|
|
args: release --rm-dist
|
|
env:
|
|
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
|
|
```
|
|
|
|
## 💅 Customizing
|
|
|
|
### inputs
|
|
|
|
Following inputs can be used as `step.with` keys
|
|
|
|
| Name | Type | Default | Description |
|
|
|---------------|---------|-----------|------------------------------------------|
|
|
| `version` | String | `latest` | GoReleaser version. Example: `v0.117.0` |
|
|
| `args` | String | | Arguments to pass to GoReleaser |
|
|
|
|
## 🤝 How can I help ?
|
|
|
|
All kinds of contributions are welcome :raised_hands:!<br />
|
|
The most basic way to show your support is to star :star2: the project, or to raise issues :speech_balloon:<br />
|
|
But we're not gonna lie to each other, I'd rather you buy me a beer or two :beers:!
|
|
|
|
[](https://www.patreon.com/crazymax)
|
|
[](https://www.paypal.me/crazyws)
|
|
|
|
## 📝 License
|
|
|
|
MIT. See `LICENSE` for more details.
|