aboutsummaryrefslogtreecommitdiffstats
path: root/RELEASE-CHECKLIST.md
blob: 888147f74762dcfd90fc7b9c04c389df0cd542fb (plain) (blame)
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
# Preparation

- Create a new branch `x.y` and base all commits on it.

# Getting the final binary

- Run `$ cargo update`.
- Check `$ cargo outdated`.
- Build final version:
  - `$ MUM_VERSION=x.y.z RUSTFLAGS="--remap-path-prefix=$(pwd)=" cargo build --release`
  - `$ strip target/release/mum{ctl,d}`
  - `$ cp target/release/mum{ctl,d}`
- Basic test:
  - Check `--version`.
  - Connect to server.
  - Connect with official mumble client.
  - Mute mumd and check if sound can be received.
  - Mute mumble and check if sound can be sent.
  - Check status.
  - Send a text message.
  - Receive a text message.

# Publish to Github

- Set the version header and today's date in the changelog.
- Create a new "Unreleased" header.
- Final commits:
  - Cargo.lock and Cargo.toml.
  - Updated changelog.
- Create a tag: `$ git tag vx.y.z`.
- Merge into main: `$ git switch main && git merge --no-ff x.y`.
- Push both branches and the tag.
- Create a new release on Github targeting the pushed tag.
  - Copy the changelog (change headers to `##`-headers).
  - Copy the output of `$ git diff va.b.c..vx.y.z --stat=80` where a.b.c is the
    previously released version.

# Publish to the AUR (-git)

- Clone the AUR repository.
- Test `$ makepkg && sudo pacman -U <generated .tar.zst>`.
- If any changes to the `MAKEPKG` have to be made:
  - Make the change.
  - Test again.
  - Update the .SRCINFO with `$ makepkg --printsrcinfo > .SRCINFO`.
  - Commit and push.
- Don't commit and push if nothing but the release number changed..

# Publish to crates.io

Note that there might be a delay where crates.io catches up to the updated
repository.

- `$ (cd mumlib && cargo publish)`
- `$ (cd mumd && cargo publish)`
- `$ (cd mumctl && cargo publish)`