Skip to content

Commit 8f183da

Browse files
committed
chore: document release process
1 parent b0a6168 commit 8f183da

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

README.md

+14
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,17 @@ To run the tests, run:
7272
```bash
7373
make test
7474
```
75+
76+
# Releasing
77+
78+
To release merge the auto-created Release PR
79+
([example](https://github.com/syntasso/kratix-cli/pull/48)). This PR is auto
80+
created by the [Release Please](https://github.com/googleapis/release-please)
81+
Github Action we have in our `.github/workflows/release.yml` file. When this PR
82+
is merged the following happens:
83+
84+
- A tag and Github release is created. The release notes is equal to the
85+
contents of the PRs description (**NOT the contents of the file committed**).
86+
- Goreleaser gets triggered in Github actions, creating and uploading the binaries to the
87+
existing release.
88+

0 commit comments

Comments
 (0)