From a068a286e645225e42fdb1f01d0b2249a9da871d Mon Sep 17 00:00:00 2001 From: Henry Mercer Date: Wed, 11 Aug 2021 17:50:47 +0100 Subject: [PATCH] Add brief instructions on creating a release --- CONTRIBUTING.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1b61be1f9..2f5c2220a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -58,6 +58,12 @@ Here are a few things you can do that will increase the likelihood of your pull - Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. - Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html). +## Releasing (write access required) + +1. Trigger a run of the "Update release branch" workflow using [workflow dispatch](https://github.com/github/codeql-action/actions/workflows/update-release-branch.yml). +1. The workflow run will open a pull request titled "Merge main into v1". [Mark](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) the pull request as ready for review to trigger the PR checks. +1. Review the checklist items in the pull request description. Once the mergeback PR is merged back into main, the release is complete. + ## Resources - [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)