Skip to content

Commit

Permalink
chore: document release process
Browse files Browse the repository at this point in the history
  • Loading branch information
aclevername committed Jul 30, 2024
1 parent b0a6168 commit 8f183da
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,3 +72,17 @@ To run the tests, run:
```bash
make test
```

# Releasing

To release merge the auto-created Release PR
([example](https://github.com/syntasso/kratix-cli/pull/48)). This PR is auto
created by the [Release Please](https://github.com/googleapis/release-please)
Github Action we have in our `.github/workflows/release.yml` file. When this PR
is merged the following happens:

- A tag and Github release is created. The release notes is equal to the
contents of the PRs description (**NOT the contents of the file committed**).
- Goreleaser gets triggered in Github actions, creating and uploading the binaries to the
existing release.

0 comments on commit 8f183da

Please sign in to comment.