Release process

Introduction

The page documents the process of releasing a new revision of numba-dpex.

Background

Branch organization of the numba-dpex got repository:

• main: Current tip of stable development snapshot.
• gold/2021: Production branch off which releases are done.
• releaseX.XX: Release branch

The main branch contains the latest development snapshot and should be stable without any guarantees. gold/2021 is our production branch that is used for oneAPI product releases. Release CI along with software-development-lifecycle (SDL) and other checks are run off gold/2021 prior to every release.

A new releaseX.XX branch is created for each release and stores the tags for that specific release. The reason for a release branch is to enable we can backport specific fixes to an earlier released version of the software.

Release process and creating tags

1. Update any docs and example changes and merge into main.
2. Update changelog and merge into main.
3. Create a new releaseX.XX branch.
4. Merge main into the releaseX.XX branch.
5. Merge releaseX.XX into gold/2021 and wait for release CI and SDL to be completed.
6. Create a new soft tag off gold/2021.
7. Create a new GitHub release from the latest tag and copy over the changelog entries into the release note. (Extra credit: come up with a cool name for the release)
8. Notify release team so that they can package and distribute the latest release to intel and internal conda channels.