From 8d877122449b3f298a71f336b84033fc43c879bd Mon Sep 17 00:00:00 2001 From: Nicklas Lundin Date: Mon, 16 Oct 2023 17:55:46 +0200 Subject: [PATCH] docs: add release instructions (#57) Signed-off-by: Nicklas Lundin --- CONTRIBUTING.md | 14 +++++++++++++- 1 file changed, 13 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 048b5b8..8ede69b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,4 +14,16 @@ Please consider adding a pre-commit hook for formatting using Manual formatting is done by invoking ``` ./gradlew ktlintFormat -``` \ No newline at end of file +``` + +## Releases + +This repo uses _Release Please_ to release packages. Release Please sets up a running PR that tracks all changes in the library, and maintains the versions according to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/), generated when [PRs are merged](https://github.com/amannn/action-semantic-pull-request), based on the PR title. The semantics of the PR title are enforced by the `lint-pr.yml` workflow. When Release Please's running PR is merged, a new release is created, and the associated artifacts are published. + +### Customization of changelog and release notes. + +If you'd like to add custom content to a release, you can do this by editing the content in a Release Please PR's description. This content will be added to the notes for that release. If you'd like to add content to the changelog, simply push updates to the changelog in the Release Please PR. + +### Configuration + +The `release-please-config.json` defines the release please configuration. See schema [here](https://github.com/googleapis/release-please/blob/main/schemas/config.json) to understand all the options. We use the "simple" release strategy and annotate the `build.gradle.kts` file(s) with an element to help release please find the correct line to update version. Release Please stores it's understanding of the current version in the `version.txt` file.