blob: 8b368977fb3a5c07249ca4ba8003cdb8c667e3c1 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
|
# Release
This document contains all information related to release.
## Checklist
This checklist details the `gfold` release process.
Steps should be executed in sequential order.
- [ ] Checkout and rebase `main` to its latest commit, then checkout a new branch
- [ ] Change the `version` field in [`Cargo.toml`](../crates/gfold/Cargo.toml) to the new tag
- [ ] **Full Releases Only**: change the version in `CHANGELOG.md` and uncomment the following line: `<!--The latest version contains all changes.-->`
- [ ] Verify that everything looks/works as expected:
```shell
cargo xtask ci
```
- [ ] Create and _do not merge_ a commit with the following message: `Update to <tag>`
- [ ] Test and verify the publishing workflow:
```shell
cargo publish --dry-run -p gfold
```
- [ ] Merge the preparation commit into `main`
- [ ] Checkout and rebase `main` to its latest commit, which should be the aforementioned commit
- [ ] Tag and push the tag:
```shell
git tag <tag>
git push --tags origin main
```
- [ ] Publish the crate:
```shell
cargo publish -p gfold
```
- [ ] Verify that the [crate](https://crates.io/crates/gfold) on `crates.io` looks correct
- [ ] Download and install the crate:
```shell
# Full releases
cargo install --locked gfold
# Release candidates (RCs)
cargo install --locked --version <tag> gfold
```
- [ ] Verify that the [GitHub release](https://github.com/nickgerace/gfold/releases) on the repository's releases page looks correct
- [ ] **Full Releases Only**: Update the formula for the [Hombrew tap](https://github.com/nickgerace/homebrew-nickgerace)
## Versioning Scheme
This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
Generally, the versioning scheme looks like the following formats where `X` is an unsigned integer:
- **Release candidates (RCs):** `X.X.X-rc.X`
- **Full releases:** `X.X.X`
|
