Skip to content

Add MAINTAINING.md #168

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add MAINTAINING.md #168

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions MAINTAINING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# `cairo-coverage` Maintenance

## Release Procedure

To release a new version of `cairo-coverage`, follow these steps:

1. **Prepare a Pull Request (PR)**:
- Ensure the correct version is updated in the following files:
- `Cargo.toml`
- `Cargo.lock`
- `CHANGELOG.md`
- As a reference, you can check this [PR](https://github.com/software-mansion/cairo-coverage/pull/116/files).

2. **Run the Release Action**:
- Trigger the [release workflow](https://github.com/software-mansion/cairo-coverage/actions/workflows/release.yml) from the branch you want to release.
- It is recommended to run this from the `main` branch.
- Ensure that the commit you are releasing from has passed CI checks, as this is not automatically verified.
- The workflow will create a tag, generate a new GitHub release with built binaries, and include the contents of `CHANGELOG.md`.

3. **Announce the Release**:
- Notify the community about the update on **Twitter, Telegram, and Discord**.
Loading