https://github.com/sheepla/goreleaser-example

⚙ An example repository for automating Go build and release with goreleaser + GitHub Actions
https://github.com/sheepla/goreleaser-example

example github-actions github-workflows go goreleaser release

Last synced: 11 months ago
JSON representation

⚙ An example repository for automating Go build and release with goreleaser + GitHub Actions

• Host: GitHub
• URL: https://github.com/sheepla/goreleaser-example
• Owner: sheepla
• License: unlicense
• Created: 2022-05-05T07:40:49.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-05-05T09:36:16.000Z (over 3 years ago)
• Last Synced: 2025-01-10T21:30:09.021Z (about 1 year ago)
• Topics: example, github-actions, github-workflows, go, goreleaser, release
• Language: Makefile
• Homepage:
• Size: 10.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


![Release](https://github.com/sheepla/goreleaser-example/actions/workflows/release.yml/badge.svg)

![Latest Release](https://img.shields.io/github/v/release/sheepla/goreleaser-example?style=flat-square)



# goreleaser-example

## About

An example repository for [goreleaser](https://goreleaser.com) + [GitHub Actions](https://docs.github.com/ja/actions/learn-github-actions/understanding-github-actions)

*This is an experimental repository. See official documentations for details!*

## Features

- Cross compile for Windows, Darwin, Linux and release executables automatically

- Embed versions and revisions in binaries via `go build -ldflags ...`

## Requirements

- [goreleaser](https://github.com/goreleaser/goreleaser)

- [GitHub CLI](https://github.com/cli/cli)

## Getting started

1. create your repository

1. copy [release.yml](.github/workflows/release.yml) to your repository

1. create [.goreleaser.yaml](.goreleaser.yaml): `goreleaser init`

1. edit [.goreleaser.yaml](.goreleaser.yaml) to customize build options, etc...

See the document: [goreleaser - Customization](https://goreleaser.com/customization/)

1. create release with [GitHub CLI](https://github.com/cli/cli): `gh release create`

1. The build will run automatically and the binaries will be uploaded to the [release](https://github.com/sheepla/goreleaser-example/releases/latest) page

## Documents

- [goreleaser](https://goreleaser.com/customization)

- [GitHub Actions](https://docs.github.com/ja/actions/learn-github-actions/understanding-github-actions)

- [GitHub CLI](https://cli.github.com/manual/index)

## License

[The Unlicense](./LICENSE)

## Author

[Sheepla](https://github.com/sheepla/)