Release Process of OMC Packages¶
Our packages' release process to PyPI is automated through Github Actions, and triggered by manually creating a release from the Github repository.
When the final changes for a release, including updating the package's version number and updating the Changelog.md
file, have been merged into the master
branch, the release process is as follows:
- Go to the
Releases
section and clickDraft a new release
in the top right. - Enter the package's version number in the
tag version
field. - Enter a
Release title
- we usually go byRelease <version_number>
. - Enter a description for the
added
,fixed
andchanged
elements, which is usually the same content as the one added to theCHANGELOG.md
file. - Click
Publish Release
. A snapshot of the source code frommaster
will automatically be attached.
A publish
workflow will be triggered, build source distribution and wheels and upload these to pylhc
's PyPI.