Skip to content

Add docs on how to cut a release #87

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

Merged
armanbilge merged 3 commits into from
Jan 21, 2022
Merged

Add docs on how to cut a release #87

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
85d93ac
Add docs on how to cut a release
armanbilge Jan 21, 2022
c3c0150
You can also release locally, if that's your thing
armanbilge Jan 21, 2022
7792bf6
GPG -> PGP Keys
armanbilge Jan 21, 2022
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
6 changes: 6 additions & 0 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ Then, on GitHub set the following secrets on your repository:

## FAQ

### How do I cut a release?

Create a release on GitHub with a v-prefixed, semantically-versioned tag (or, tag a commit locally and push to GitHub). This will start a CI release. Example tags: `v0.4.2`, `v1.2.3`, `v1.0.0-M1`, `v1.2.0-RC2`.

It is also possible to run the release process entirely locally by invoking the `tlRelease` command, assuming that you have correctly configured your PGP keys and Sonatype credentials.

### How do I introduce breaking changes intended for my next version?

Bump your `tlBaseVersion` to the next breaking-version according to early-semver, e.g. 0.7 to 0.8 or 4.2 to 5.0.
Expand Down