Skip to content

release-process.md

Latest commit

 

History

History
40 lines (30 loc) · 1.18 KB

release-process.md

File metadata and controls

40 lines (30 loc) · 1.18 KB

Release Process

The following steps are needed to create a release.

  1. Prepare for Release

    • Create a new branch for the release and generate the changelog:

      export VERSION=v0.0.1
git checkout -b <user>/release-${VERSION}
make changelog

  2. Review and Update the Changelog

    • Review the generated changelog and make updates if necessary.
    • If needed (e.g., for a minor release), manually update the version in .punch_version.py to match the release version.
    • Add a Deployment Notes section to the changelog, if relevant or needed.

  3. Create and Merge a Pull Request

    • Create a pull request from the <user>/release-${VERSION} branch.
    • Get the pull request reviewed and merged into main.

  4. Pull the Latest Changes

    • Switch to the main branch and pull the latest changes:

      git checkout main
git pull

  5. Create the Release Tag

    • Run the following command to create the release tag:

      make release-tag

    • This will trigger the release GitHub Action to create and publish the release, including the changelog with changes since the previous release.