Skip to content
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

Jump to bottom

docs: add release instructions #57

Merged
merged 2 commits into from
Oct 16, 2023
Merged

docs: add release instructions #57

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
716333b
docs: add release instructions
nicklasl Oct 16, 2023
e797577
Update CONTRIBUTING.md
nicklasl Oct 16, 2023
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
14 changes: 13 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,16 @@ Please consider adding a pre-commit hook for formatting using
Manual formatting is done by invoking
```
./gradlew ktlintFormat
```
```

## 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.