Skip to content

Commit

Permalink
docs: document release process
Browse files Browse the repository at this point in the history
Signed-off-by: Marvin Beckers <mail@embik.me>
  • Loading branch information
embik committed Feb 3, 2024
1 parent d0d261c commit d13659c
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions docs/development/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Development

## New Releases

Requirements to release:

- Be logged into crates.io.
- Have [cargo release](https://github.com/crate-ci/cargo-release) installed.

To cut a new release, do the following steps:

1. Bump `version` in [Cargo.toml](./Cargo.toml) to the next version.
1. Run `cargo check` so Cargo.lock gets updated.
1. Commit changes and commit as `cargo: bump to version <version>`.
1. Run `cargo release --sign-tag --sign-commit` to check if release is functional.
1. Run `cargo release --sign-tag --sign-commit --execute` to push release to crates.io and GitHub.
1. Go to [Tags](https://github.com/embik/kubeconfig-bikeshed/tags) and create release from it.

0 comments on commit d13659c

Please sign in to comment.