Skip to content

Commit 1cf1ced

Browse files
committed
Add MAINTAINING.md
commit-id:6fd4f32c
1 parent bb07767 commit 1cf1ced

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

MAINTAINING.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# `cairo-coverage` Maintenance
2+
3+
## Release Procedure
4+
5+
To release a new version of `cairo-coverage`, follow these steps:
6+
7+
1. **Prepare a Pull Request (PR)**:
8+
- Ensure the correct version is updated in the following files:
9+
- `Cargo.toml`
10+
- `Cargo.lock`
11+
- `CHANGELOG.md`
12+
- As a reference, you can check this [PR](https://github.com/software-mansion/cairo-coverage/pull/116/files).
13+
14+
2. **Run the Release Action**:
15+
- Trigger the [release workflow](https://github.com/software-mansion/cairo-coverage/actions/workflows/release.yml) from the branch you want to release.
16+
- It is recommended to run this from the `main` branch.
17+
- Ensure that the commit you are releasing from has passed CI checks, as this is not automatically verified.
18+
- The workflow will create a tag, generate a new GitHub release with built binaries, and include the contents of `CHANGELOG.md`.
19+
20+
3. **Announce the Release**:
21+
- Notify the community about the update on **Twitter, Telegram, and Discord**.

0 commit comments

Comments
 (0)