Release Process

The following process describes the steps of releasing a new version of the issue-labeler. The steps begin at the stage of the main branch containing what is desired to be marked as a new version of the workflows. The release process requires a few iterations can capturing multiple commit SHA values to ensure each release is fully pinned to a consistent state through each layer of the architecture.

1. Capture the SHA for the commit to be staged as a release

This will be referred to as SHA A below. In the example, SHA A is d74b8e18f41673790be3d0ca87296a49e81ac19a.

2. Edit all of the /.github/worklows files that use actions/checkout

Update the ref to the SHA A in each usage of actions/checkout. This will snap the reusable workflows that consume the code from the repository to the desired commit.

      - name: "Check out the 'dotnet/issue-labeler' repo"
        uses: actions/checkout@v4
        with:
          repository: dotnet/issue-labeler
          ref: d74b8e18f41673790be3d0ca87296a49e81ac19a# Staging v1.0.1

The files to be edited are:

1. build-predictor.yml
2. download-issues.yml
3. download-pulls.yml
4. test-issues.yml
5. test-pulls.yml
6. train-issues.yml
7. train-pulls.yml

Merge those file updates and capture this new commit SHA. This will be referred to as SHA B below. See Staging the v1.0.1 release (dotnet/issue-labeler#89) for an example of where this step of the release process was completed. In this example, SHA B is 68a3df3b6444ec3e2a37af4d5e2569df1d45201d.