Skip to content

Commit 8d87712

Browse files
authored
docs: add release instructions (#57)
Signed-off-by: Nicklas Lundin <[email protected]>
1 parent 11824ed commit 8d87712

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,16 @@ Please consider adding a pre-commit hook for formatting using
1414
Manual formatting is done by invoking
1515
```
1616
./gradlew ktlintFormat
17-
```
17+
```
18+
19+
## Releases
20+
21+
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.
22+
23+
### Customization of changelog and release notes.
24+
25+
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.
26+
27+
### Configuration
28+
29+
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.

0 commit comments

Comments
 (0)