Skip to content

Add doc on how to release #3

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

Merged
manu-paylead merged 1 commit into from
Mar 6, 2025
Merged

Add doc on how to release #3

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
8 changes: 8 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,14 @@ def pytest_assertrepr_compare(config, op, left, right):
return assertrepr_compare(config, op, left, right)
```

## Releasing a new version

```bash
# in your local shell
bumpver update ## Updates the version number, commits the change, tags the commit
git push # The deployment is made on tag push
```

## Contributing 🤝

Issues, feature requests, and contributions are warmly welcomed! Feel free to open a pull request or submit an issue.
Expand Down