Skip to content

Document release process #479

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
apaleyes merged 1 commit into from
Dec 19, 2025
Merged

Document release process #479

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
13 changes: 13 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,19 @@ If you'd like to generate the docs locally, from inside the "doc" directory, run
make html
```

## How to create a new release
Step by step guide on releasing new version of Emukit. Mostly useful for project maintenance team.

1. Update changelog file with most relevant changes since the last release
1. Update `emukit/__version__.py` with new version
1. Add both files and commit them with the message "Release <version>"
1. Create new venv and install two packages: `build` and `twine`
1. Generate new build with `python -m build --sdist --wheel`
1. Ensure your PyPI creds are available in `~/.pypirc`
1. Upload build to PyPI with `twine upload dist/*`
1. In a separate clean environment install new version to ensure installation works fine
1. Done!

## Licensing

See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
Expand Down