Skip to content

Commit

Permalink
chore: disable semver check and update release.md
Browse files Browse the repository at this point in the history
  • Loading branch information
antonbaliasnikov committed Dec 5, 2024
1 parent a061354 commit 1c24b66
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 6 deletions.
7 changes: 2 additions & 5 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
## Automatic releases

We use [release-please](https://github.com/googleapis/release-please) to manage releases, as well
as a custom automation to publish releases on [crates.io](https://crates.io/).
We use [release-plz](https://release-plz.dev/) to manage and publish releases to [crates.io](https://crates.io/).

Any pull request name must follow [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
specification, and then, based on the PR titles, a release pull request will be created, which
Expand All @@ -22,7 +21,7 @@ sure that the change will trigger a release PR, mark the PR as `fix` or `feat`.
By default, a patch version will be bumped. If you want to bump a minor version, mark the PR as breaking with
an exclamation point, e.g. `feat!` or `fix!`.

It is recommended that each PR has a component mentioned, e.g. `feat(component): Change added`.
It is recommended that each PR has a component mentioned, e.g. `feat(component): change added`.

Once release PR is merged, it will be published to `crates.io`, and a notification will be sent to Slack.

Expand All @@ -31,8 +30,6 @@ Once release PR is merged, it will be published to `crates.io`, and a notificati
> [!WARNING]
> Manual releases are discouraged, and should only be used as a last resort measure.
> Discuss the manual release with the team beforehand and prepare a plan.
> It is very likely that manual release will interfere with `release-please` configuration,
> which will have to be fixed manually as well.
>
> Additionally, if the release was created, but wasn't published, you will only need a subset
> of the actions listed below (e.g. if the it failed due to a transient error, you just need to
Expand Down
2 changes: 1 addition & 1 deletion release-plz.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ changelog_path = "./CHANGELOG.md" # Set common changelog path for all
changelog_update = false # Disable individual changelog updates for all packages.
git_tag_enable = false # Disable individual tags for all packages.
git_release_enable = false # Disable individual releases for all packages.
semver_check = true # Enable API breaking changes checks with cargo-semver-checks.
semver_check = false # Disable API breaking changes checks with cargo-semver-checks.
publish_timeout = "10m" # Set a timeout for `cargo publish`.

# Use one package to combine changelog updates and tags for all workspace
Expand Down

0 comments on commit 1c24b66

Please sign in to comment.