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.

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

Adds releasing guidelines #94

Merged
merged 1 commit into from
May 9, 2024
Merged
Changes from all commits
Commits
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
37 changes: 37 additions & 0 deletions docs/releasing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Releasing new versions

## Preparing the release

- Understand what changes we are shipping by inspecting unreleased commits

```bash
git co main
git pull origin main --rebase
git log $(git describe --abbrev=0 --tags)...HEAD --oneline
```

- Determine next release version according to [SemVer](https://semver.org/)
- Create a short-lived branch

```bash
git checkout -b ufs/release-x.y.z
```

- Add **notable changes** the to [changelog file](https:/dotanuki-labs/gradle-wiper/blob/main/docs/changelog.md)
- Bump version at [Cargo.toml](https:/dotanuki-labs/gradle-wiper/blob/main/Cargo.toml#L3)
- Raise a PR preparing the release

## Creating a release (GitHub admins-only)

- Ensure the next release is prepared (as described above)
- Execute the [CD Workflow](https:/dotanuki-labs/gradle-wiper/actions/workflows/cd.yml)
- Go to the [releases page](https:/dotanuki-labs/gradle-wiper/releases)
- Review the release draft and add any final touches (for instance, updating `RenovateBot` identity name)
- Publish the release 🚀

## Updating distributions

- Clone [dotanuki-labs/homebrew-taps](https:/dotanuki-labs/homebrew-taps)
- Create a branch like `ufs/gradle-wiper-x.y.z`
- Update the `gradle-wiper.rb` formula with proper version and checksums
- Raise a PR