Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.55 KB

RELEASE.md

File metadata and controls

31 lines (21 loc) · 1.55 KB
Raw

Versioning

The project uses release versioning a format YY.MM.DD (both for pip packages and image tags). For instance, when releasing a version on Sep 15, 2021, it would be versionsed as 21.9.15 (no zero before 9).

Release process

Suppose, today is October 15, 2020, and we want to update both apolo-extras pip package and docker image.

  1. Make sure all tests are green in master branch.

  2. Bump code version directly to master.

    • git checkout master;
    • update apolo_extras/version.py: set __version__ = "20.10.15";
    • run make changelog-draft and verify changelog looks valid;
    • run make changelog - this will delete changelog items from CHANGELOG.d;
    • git add CHANGELOG* apolo_extras/version.py && git commit -m "Release v$(python setup.py --version)" and push directly to origin/master;
    • wait for green build in Actions;

  3. Submit a release on GitHub.

    • go to Releases, Draft a new release, tag: v20.10.15 (note: no postfixes);
    • wait for green build in Actions;
    • if the build failed, fix the errors and repeat from step 1. with version postfix: v20.10.15-1.
    • verify that pip install -U apolo-extras does install apolo-extras==20.10.15

Alpha release

To debug a release process without changing latest versions of package and image, you can issue an alpha release just postfixing the version with a:

  • 20.10.15a1
  • 20.10.15a2