Skip to content

RELEASING.md

Latest commit

 

History

History
43 lines (30 loc) · 1.41 KB

RELEASING.md

File metadata and controls

43 lines (30 loc) · 1.41 KB

Releasing the ETA package

Note

These steps are to be performed by authorized Voxel51 engineers.

The voxel51-eta repository follows Gitflow. Releases will be initiated when a teammate submits a pull request from their respective release/v* branch to main. We can see an example PR for version 0.15.1. Reviewers should always check that the version in the setup.py matches the branch version.

The release engineer will merge the pull request once it is approved.

The PyPI uploads will be triggered when a release tag is pushed to the repository:

  1. Navigate to the releases page.

  2. Select Draft a new release.

  3. Select Create new tag with the appropriate version and set the target to main.

    1. The tag format is v<semantic-version>. For example, v0.15.1. This should match the setup.py and release branch.

  4. Select Generate release notes.

  5. Select Set as the latest release.

  6. Select Publish release.

This will create a new tag in the repository and will trigger the build/publish workflow. This workflow will build the .whl artifacts and publish them to PyPI.

Once the build are finished, submit a PR from main to develop to complete the Gitflow process.