Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adds maintainers guide with release process #637

Merged
merged 1 commit into from
Jul 19, 2024
Merged

Adds maintainers guide with release process #637

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions MAINTAINERS_GUIDE.md
View file
Open in desktop
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.
Loading