From 18bd47f5d5bc72e51a302ec6df2827224ba618c6 Mon Sep 17 00:00:00 2001 From: yuma14 Date: Wed, 4 Sep 2024 21:04:01 +0900 Subject: [PATCH] doc: how to release --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 1636d05..d6bbcea 100644 --- a/README.md +++ b/README.md @@ -50,3 +50,11 @@ cargo binstall tempura https://yuma14.net/tempura-doc/ +## How to make releases + +1. `release/v1.2.3` のような名前のブランチを切る +2. `Cargo.toml` のバージョン番号を更新する +3. 手元で `cargo build` を実行して `Cargo.lock` を更新する +4. Pull Request を作る。[pre-release.yml](.github/workflows/pre-release.yml) が実行されて [CHANGELOG.md](CHANGELOG.md) が更新される。 +5. すべてのチェックが通れば Pull Request をクローズする。[release.yml](.github/workflows/release.yml) が実行されて crates.io と GitHub のリリースページにリリースが作られる。 +6. ブランチは削除せずに残しておくものとする