-
Notifications
You must be signed in to change notification settings - Fork 104
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adds maintainers guide with release process (#637)
Authored-by: Wayne Adams <[email protected]>
- Loading branch information
1 parent
34f79b6
commit 5839764
Showing
1 changed file
with
28 additions
and
0 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 |
---|---|---|
@@ -0,0 +1,28 @@ | ||
# Maintainer's Guide Notes | ||
|
||
## Release Process | ||
|
||
We use [GoReleaser]() to do the heavy lifing when releasing new versions of [om](https://github.com/pivotal-cf/om). | ||
|
||
It will create a new GitHub release, attach the binaries, and update the Homebrew formula. | ||
|
||
Here's a quick rundown of the process: | ||
|
||
1. Make sure you have the latest version of GoReleaser installed. See [install instructions](https://goreleaser.com/install/). | ||
|
||
2. Ensure you have explorted your GitHub token as an environment variable. | ||
``` | ||
export GITHUB_TOKEN=<your_token> | ||
``` | ||
3. Create a new tag for the release. | ||
``` | ||
git tag -a <Major.Minor.Patch> -m "Release v<version>" | ||
git push origin <Major.Minor.Patch> | ||
``` | ||
4. Run GoReleaser to create the release. | ||
``` | ||
goreleaser release | ||
``` | ||
5. Edit the newly created release on [GitHub](https://github.com/pivotal-cf/om/releases). There's feature to automatically create release notes between two tags. Use it and then clean up redundant or uninformative entries. See these [instructions](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release) for more information. |