Skip to content

Commit 0ce9708

Browse files
authored
Merge pull request #2152 from github/angelapwen/update-release-docs
Update release documentation with `v3` instructions
2 parents 65b0987 + 2ddf87a commit 0ce9708

File tree

1 file changed

+5
-9
lines changed

1 file changed

+5
-9
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -57,18 +57,14 @@ Here are a few things you can do that will increase the likelihood of your pull
5757
## Releasing (write access required)
5858

5959
1. The first step of releasing a new version of the `codeql-action` is running the "Update release branch" workflow.
60-
This workflow goes through the pull requests that have been merged to `main` since the last release, creates a changelog, then opens a pull request to merge the changes since the last release into the `releases/v2` release branch.
60+
This workflow goes through the pull requests that have been merged to `main` since the last release, creates a changelog, then opens a pull request to merge the changes since the last release into the `releases/v3` release branch.
6161

6262
You can start a release by triggering this workflow via [workflow dispatch](https://github.com/github/codeql-action/actions/workflows/update-release-branch.yml).
63-
1. The workflow run will open a pull request titled "Merge main into releases/v2". Mark the pull request as [ready for review](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request#marking-a-pull-request-as-ready-for-review) to trigger the PR checks.
64-
1. Review the checklist items in the pull request description.
65-
Once you've checked off all but the last two of these, approve the PR and automerge it.
66-
1. When the "Merge main into releases/v2" pull request is merged into the `releases/v2` branch, the "Tag release and merge back" workflow will create a mergeback PR.
67-
This mergeback incorporates the changelog updates into `main`, tags the release using the merge commit of the "Merge main into releases/v2" pull request, and bumps the patch version of the CodeQL Action.
63+
1. The workflow run will open a pull request titled "Merge main into releases/v3". Follow the steps on the checklist in the pull request. Once you've checked off all but the last two of these, approve the PR and automerge it.
64+
1. When the "Merge main into releases/v3" pull request is merged into the `releases/v3` branch, a mergeback pull request to `main` and a backport pull request to `releases/v2` will both be automatically created. This mergeback pull request incorporates the changelog updates into `main`, tags the release using the merge commit of the "Merge main into releases/v3" pull request, and bumps the patch version of the CodeQL Action. The backport pull request will incorporate the updates into `releases/v2`.
65+
1. Approve the mergeback and backport pull requests and automerge them.
6866

69-
Approve the mergeback PR and automerge it.
70-
71-
Once the mergeback has been merged to `main`, the release is complete.
67+
Once the mergeback and backport pull request have been merged, the release is complete.
7268

7369
## Keeping the PR checks up to date (admin access required)
7470

0 commit comments

Comments
 (0)