2024-07-12 18:59:06 +03:00
# Release Process
This doc outlines how supervision is released into production.
It assumes you already have the code changes, as well as a draft of the release notes.
1. Make sure you have all required changes were merged into `develop` .
2024-07-12 19:10:25 +03:00
2. Create and merge a PR, merging `develop` into `main` , containing:
2024-09-27 14:17:34 +03:00
- A commit that updates the project version in `pyproject.toml` .
- All changes made during the release.
2024-07-12 18:59:06 +03:00
3. Tag the commit with the new supervision version.
2024-09-27 14:17:34 +03:00
- make sure to pull from `main` !
- Verify that the latest merge commits exists. `git log` .
- Run `git tag x.y.z` , with your version
- Check with `git log` .
- Run `git push origin --tags`
2026-01-27 15:02:15 +09:00
- Upon pushing the Github release, the [PyPi ](https://pypi.org/project/supervision/ ) should update to the new version. Check this!
2024-07-15 21:27:11 +03:00
4. Open and merge a PR, merging `main` into `develop` .
5. Update the docs by running the [Supervision Release Documentation Workflow 📚 ](https://github.com/roboflow/supervision/actions/workflows/publish-release-docs.yml ) workflow from GitHub.
2024-09-27 14:17:34 +03:00
- Select the `main` branch from the dropdown.
2024-07-15 21:27:11 +03:00
6. Create a release on GitHub.
2024-09-27 14:17:34 +03:00
- Go to releases
- Assign the release notes to the tag created in step 3.
- Publish the release.
