Skip to content

Commit

Permalink
Favor main branch over release branch for releases
Browse files Browse the repository at this point in the history
  • Loading branch information
carreter committed Dec 19, 2023
1 parent f81ffeb commit 563b0d5
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,16 +128,16 @@ looks like so: `vMAJOR.MINOR.PATCH`. We also keep a changelog in `CHANGELOG.md`.
versions indicate breaking changes to the API, minor versions indicate backwards-compatible
additions to the API, and patch versions indicate bugfixes.

### Cutting a Major or Minor Release
### Cutting a Release

> NOTE: Only contributors with write access to the repository can do this.
To cut a release, check out the `release` branch, merge any desired changes,
To cut a release, check out the `main` branch, merge any desired changes,
and then run `just cut-release <version>` (without the `v` before the version number). This
will perform the following actions locally:

1. Lint and test the codebase
2. Update the changelog and commit it
2. Bump the version in the changelog and commit it
3. `git tag` the commit as `v<version>`

Afterward, simply run `git push` and `git push <remote> v<version>` to upload the new commit
Expand Down
1 change: 0 additions & 1 deletion justfile
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@ branch := `git branch --show-current`

# Bump version in changelog and create commit + tag on current branch
cut-release $NEW_VERSION:
{{if branch != "release" {error("Releases can only be cut in the releases branch.")} else {""} }}
just lint
just test
sed -i "s/## \[Unreleased]\s*\n*/## [Unreleased]\n\n## [$NEW_VERSION] $(date +'%Y-%m-%d')/g" CHANGELOG.md
Expand Down

0 comments on commit 563b0d5

Please sign in to comment.