-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add release instructions to README (#190)
- Loading branch information
Showing
1 changed file
with
24 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,33 @@ | ||
# Aviator Command Line Tool | ||
|
||
See the [Aviator Stacked PRs quickstart](https://docs.aviator.co/getting-started/stacked-prs) for more information. | ||
See the | ||
[Aviator Stacked PRs quickstart](https://docs.aviator.co/getting-started/stacked-prs) | ||
for more information. | ||
|
||
# Development setup | ||
This project is built using Go 1.18.1. | ||
|
||
Install the latest version of Go from https://go.dev/doc/install. | ||
|
||
To run the command line: | ||
|
||
``` | ||
go run ./cmd/av [subcommand/flags...] | ||
``` | ||
|
||
# Release | ||
|
||
To create a release, create a tag with the desired version and push to GitHub. | ||
|
||
``` | ||
# Change the version as appropriate | ||
TAG="v0.0.0" | ||
git tag "$TAG" | ||
git push origin tags/"$TAG" | ||
``` | ||
|
||
This will automatically trigger [Goreleaser](https://goreleaser.com/) (as part | ||
of the | ||
[`release.yml` workflow](https://github.com/aviator-co/av/blob/master/.github/workflows/release.yml)) | ||
which will create a GitHub release and build and publish binaries to Homebrew | ||
and Scoop. |