You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: book/src/dev/release-checklist.md
+49-44
Original file line number
Diff line number
Diff line change
@@ -8,103 +8,108 @@ releases easier.
8
8
9
9
## One-time crates.io setup
10
10
11
-
1. Follow the steps in <https://doc.rust-lang.org/cargo/reference/publishing.html#before-your-first-publish> (you can create a token scoped to `publish-update`).
12
-
2. To get permissions to publish you’ll need to be in the [owners](https://github.com/orgs/ZcashFoundation/teams/owners) group. If you aren’t in there, ask someone in that group to add you
11
+
- Follow the steps in <https://doc.rust-lang.org/cargo/reference/publishing.html#before-your-first-publish> (you can create a token scoped to `publish-update`).
12
+
- To get permissions to publish you’ll need to be in the [owners](https://github.com/orgs/ZcashFoundation/teams/owners) group. If you aren’t in there, ask someone in that group to add you
13
13
14
14
15
15
## Communication
16
16
17
-
3. Post in #frost slack channel and tag the Frost team that you’re going to be doing a release to freeze PR approvals until it’s done. E.g “@frost-core I’m doing a release of \<version> of Frost. Please do not merge any more PRs until I’m finished. Thanks.”
17
+
- Post in #frost slack channel and tag the Frost team that you’re going to be doing a release to freeze PR approvals until it’s done. E.g “@frost-core I’m doing a release of \<version> of Frost. Please do not merge any more PRs until I’m finished. Thanks.”
18
18
19
19
20
20
## Checks
21
21
22
-
4. Currently all crates share the same version number, in the root Cargo.toml
22
+
- Currently all crates share the same version number, in the root Cargo.toml
23
23
file. Take note of that version. (If we ever decide to have specific
24
24
versions, update those separately as required.)
25
25
26
-
5. Decide which version to tag the release with (e.g. v0.3.0), considering
26
+
- Decide which version to tag the release with (e.g. v0.3.0), considering
6. Create new issue. E.g. [Release v0.4.0](https://github.com/ZcashFoundation/frost/issues/377)
29
+
- Create new issue. E.g. [Release v0.4.0](https://github.com/ZcashFoundation/frost/issues/377)
30
30
31
31
32
32
## Make changes
33
33
34
-
7. Bump the version of the crates in the root Cargo.toml file. (If they ever
34
+
- Bump the version of the crates in the root Cargo.toml file. (If they ever
35
35
get out of sync, you wil need to bump in each crate Cargo.toml file.)
36
36
37
-
8. Bump the version used in the tutorial (importing.md)
37
+
- Run `cargo semver-checks` to check if there are no API changes that break
38
+
SemVer compatibility. ([Installation
39
+
instructions](https://crates.io/crates/cargo-semver-checks)) Fix issues if
40
+
any (i.e. change the version, or revert/adapt the API change).
38
41
39
-
9. Check if the [changelog](https://github.com/ZcashFoundation/frost/blob/main/frost-core/CHANGELOG.md) is up to date and update if required (we’re only keeping the one in frost-core for now). Double check using [FROST releases](https://github.com/ZcashFoundation/frost/releases) which will have a list of all the PRs that have been closed since the last release. Things to include in the changelog will be anything that impacts production code and big documentation changes. I.e. script and test changes should not be included. NOTE: Please add to the changelog whenever you make changes to the library as this will make things simpler for the person in charge of the release.
42
+
- Bump the version used in the tutorial (importing.md)
40
43
41
-
1. Move version in changelog to Released
42
-
2. Create a new version in “unreleased” in changelog
44
+
- Check if the [changelog](https://github.com/ZcashFoundation/frost/blob/main/frost-core/CHANGELOG.md) is up to date and update if required (we’re only keeping the one in frost-core for now). Double check using [FROST releases](https://github.com/ZcashFoundation/frost/releases) which will have a list of all the PRs that have been closed since the last release. Things to include in the changelog will be anything that impacts production code and big documentation changes. I.e. script and test changes should not be included. NOTE: Please add to the changelog whenever you make changes to the library as this will make things simpler for the person in charge of the release.
43
45
44
-
10. Update the version number for frost-core and frost-rerandomized in the Ciphersuite crates, e.g. in `frost-core = { path = "../frost-core", version = "0.4.0", features = ["test-impl"] }`. You'll need to do this for dependencies and dev-dependencies
46
+
- Move version in changelog to Released
47
+
- Create a new version in “unreleased” in changelog
45
48
46
-
11. Create a PR with subject `Release \<version number>` containing all these changes
49
+
- Update the version number for frost-core and frost-rerandomized in the Ciphersuite crates, e.g. in `frost-core = { path = "../frost-core", version = "0.4.0", features = ["test-impl"] }`. You'll need to do this for dependencies and dev-dependencies
47
50
48
-
12. You’ll need someone to review and approve it
51
+
- Create a PR with subject `Release \<version number>` containing all these changes
49
52
50
-
13. Wait for it to pass CI checks
53
+
- You’ll need someone to review and approve it
54
+
55
+
- Wait for it to pass CI checks
51
56
52
57
53
58
## Publish
54
59
55
-
14. Checkout main branch, **in the commit of the previously merged PR** (in case other stuff got merged after that)
60
+
- Checkout main branch, **in the commit of the previously merged PR** (in case other stuff got merged after that)
56
61
57
-
15. Run `cargo publish -p frost-core --dry-run` to check if it’s ready to publish. Fix issues if any.
62
+
- Run `cargo publish -p frost-core --dry-run` to check if it’s ready to publish. Fix issues if any.
58
63
59
-
16.[Draft and publish a new release](https://github.com/ZcashFoundation/frost/releases/new) for frost-core.
64
+
-[Draft and publish a new release](https://github.com/ZcashFoundation/frost/releases/new) for frost-core.
60
65
61
-
1. In “Choose a tag” type `<crate>/<version>` e.g. “frost-core/v0.2.0” and click “Create new tag”
62
-
2. In “Target” select “main” as long as other PRs haven’t been merged after the version bump PR. Otherwise, **select the commit matching the PR that was merged above**.
63
-
3. In “Release title” use `<crate> <version>` e.g. “frost-core v0.2.0”
64
-
4. Paste the (raw Markdown) changelog for this version into the description box.
65
-
5. Leave “Set as pre-release” **unchecked** (we should have checked it in earlier versions but the ship has sailed. It doesn’t matter much)
66
-
6.**Check** “Set as the latest release”
66
+
- In “Choose a tag” type `<crate>/<version>` e.g. “frost-core/v0.2.0” and click “Create new tag”
67
+
- In “Target” select “main” as long as other PRs haven’t been merged after the version bump PR. Otherwise, **select the commit matching the PR that was merged above**.
68
+
- In “Release title” use `<crate> <version>` e.g. “frost-core v0.2.0”
69
+
- Paste the (raw Markdown) changelog for this version into the description box.
70
+
- Leave “Set as pre-release” **unchecked** (we should have checked it in earlier versions but the ship has sailed. It doesn’t matter much)
71
+
-**Check** “Set as the latest release”
67
72
68
-
17. Publish it with `cargo publish -p frost-core`
73
+
- Publish it with `cargo publish -p frost-core`
69
74
70
-
18. Check if frost-rerandomized is ready to be published: `cargo publish -p frost-rerandomized --dry-run`. Fix any errors if needed.
75
+
- Check if frost-rerandomized is ready to be published: `cargo publish -p frost-rerandomized --dry-run`. Fix any errors if needed.
71
76
72
-
19. Draft and publish a frost-rerandomized release:
20. Publish it with `cargo publish -p frost-rerandomized`
82
+
- Publish it with `cargo publish -p frost-rerandomized`
78
83
79
-
21. Check if other crates are ready to be published: `for cs in ristretto255 ed25519 secp256k1 secp256k1-tr p256 ed448; do cargo publish -p frost-$cs --dry-run; done`. Fix any issues if needed.
84
+
- Check if other crates are ready to be published: `for cs in ristretto255 ed25519 secp256k1 secp256k1-tr p256 ed448; do cargo publish -p frost-$cs --dry-run; done`. Fix any issues if needed.
80
85
81
-
1. If you get an error like this:
86
+
- If you get an error like this:
82
87
83
88
“error: failed to verify package tarball Caused by: failed to select a version for the requirement `frost-core = "^0.3.0"` candidate versions found which didn't match: 0.2.0, 0.1.0 location searched: crates.io index required by package `frost-ed25519 v0.3.0 (frost/target/package/frost-ed25519-0.3.0)`”
84
89
85
90
This is because the ciphersuite crates aren’t pointing at the new frost-core package. This is because you need to publish frost-core before you can publish the others otherwise they will not have the expected version to point to.
86
91
87
-
22. Draft and publish releases for each of those crates:
92
+
- Draft and publish releases for each of those crates:
88
93
89
-
1. Run `for cs in ristretto255 ed25519 secp256k1 secp256k1-tr p256 ed448; do gh release create "frost-$cs/v2.1.0" -n '' -t "frost-$cs v2.1.0" --latest=false; done` (replace both instances of the version)
94
+
- Run `for cs in ristretto255 ed25519 secp256k1 secp256k1-tr p256 ed448; do gh release create "frost-$cs/v2.1.0" -n '' -t "frost-$cs v2.1.0" --latest=false; done` (replace both instances of the version)
90
95
91
-
23. Publish those crates: `for cs in ristretto255 ed25519 secp256k1 secp256k1-tr p256 ed448; do cargo publish -p frost-$cs; done`
96
+
- Publish those crates: `for cs in ristretto255 ed25519 secp256k1 secp256k1-tr p256 ed448; do cargo publish -p frost-$cs; done`
92
97
93
98
94
99
## Confirm
95
100
96
-
24. Check versions in the crates to confirm everything worked:
101
+
- Check versions in the crates to confirm everything worked:
0 commit comments