Skip to content

Commit

Permalink
Release branch for v0.12.x + release rules
Browse files Browse the repository at this point in the history
  • Loading branch information
Lars T Hansen committed Oct 7, 2024
1 parent ab858a4 commit 6c815c2
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 4 deletions.
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "sonar"
version = "0.12.0"
version = "0.12.1"
edition = "2021"

# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
Expand Down
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Options:
-V, --version Print version
```

## Versions
## Versions and release procedures

We use semantic versioning. The major version is expected to remain at zero for the foreseeable
future, reflecting the experimental nature of Sonar.
Expand All @@ -47,7 +47,21 @@ itself changes. For example, v0.8.0 both added fields and stopped printing fiel
The bugfix version is updated for changes that do not alter the output format per se but that might
affect the output nevertheless, ie, most changes not covered by changes to the minor version number.

These rules are new with v0.8.0.
The versioning rules are new with v0.8.0.

For every freeze of the the minor release number, a new release branch is created in the repo with
the name `release_<major>_<minor>`, again we expect `<major>` to remain `0` for the foreseeable
future, ergo, `release_0_12` is the v0.12.x release branch. At that time, the minor release number
is to be incremented on main.

The branching scheme is new with v0.12.x.

With the branches come some additional rules:

- If a bugfix is made to a release branch it shall be uplifted to main at the time it is made.
- If a bugfix is made to main it shall be considered whether it should be backported the most
recent release branch. No older release branches shall automatically be considered for
backports.

### Changes in v0.12.x

Expand Down

0 comments on commit 6c815c2

Please sign in to comment.