Skip to content

Commit

Permalink
Add to release plan steps with point release steps (#22645)
Browse files Browse the repository at this point in the history
Add steps to use for a point releases to the release plan document so there is a reference on how to do so.
  • Loading branch information
eleanorjboyd authored Dec 13, 2023
1 parent 31abb36 commit 52b95e2
Showing 1 changed file with 33 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/release_plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,39 @@ NOTE: this PR should make all CI relating to `main` be passing again (such as th
- [ ] Determine if a hotfix is needed.
- [ ] Merge the release branch **`release/YYYY.minor`** back into `main`. (This step is only required if changes were merged into the release branch. If the only change made on the release branch is the version, this is not necessary. Overall you need to ensure you DO NOT overwrite the version on the `main` branch.)


## Steps for Point Release (if necessary)
- [ ] checkout to `main` on your local machine and run `git fetch` to ensure your local is up to date with the remote repo.
- [ ] checkout to the `release/YYY.minor` and check to make sure all necessary changes for the point release have been cherry-picked into the release branch. If not, contact the owner of the changes to do so.
- [ ] Create a branch against **`release/YYYY.minor`** called **`release-[YYYY.minor.point]`**.
- [ ] Bump the point version number in the `package.json` to the next `YYYY.minor.point`
- [ ] Run `npm install` to make sure `package-lock.json` is up-to-date _(you should now see changes to the `package.json` and `package-lock.json` only relating to the new version number)_ . (πŸ€–)
- [ ] Create a PR from this branch against `release/YYYY.minor`
- [ ] **Rebase** and merge this PR into the release branch
- [ ] Create a draft GitHub release for the release notes (πŸ€–) ❄️
- [ ] Create a new [GitHub release](https://github.com/microsoft/vscode-python/releases/new).
- [ ] Specify a new tag called `vYYYY.minor.point`.
- [ ] Have the `target` for the github release be your release branch called **`release/YYYY.minor`**.
- [ ] Create the release notes by specifying the previous tag as the previous version of stable, so the minor release **`vYYYY.minor`** for the last stable release and click `Generate release notes`.
- [ ] Check the generated notes to ensure that all PRs for the point release are included so users know these new changes.
- [ ] Click `Save draft`.
- [ ] Publish the point release
- [ ] Make sure CI is passing for **`release/YYYY.minor`** release branch (πŸ€–).
- [ ] Run the [CD](https://dev.azure.com/monacotools/Monaco/_build?definitionId=299) pipeline on the **`release/YYYY.minor`** branch.
- [ ] Click `run pipeline`.
- [ ] for `branch/tag` select the release branch which is **`release/YYYY.minor`**.
- [ ] 🧍🧍 Get approval on the release on the [CD](https://dev.azure.com/monacotools/Monaco/_build?definitionId=299) and publish the release to the marketplace. πŸŽ‰
- [ ] Take the Github release out of draft.

## Steps for contributing to a point release
- [ ] Work with team to decide if point release is necessary
- [ ] Work with team or users to verify the fix is correct and solves the problem without creating any new ones
- [ ] Create PR/PRs and merge then each into main as usual
- [ ] Make sure to still mark if the change is "bug" or "no-changelog"
- [ ] Cherry-pick all PRs to the release branch and check that the changes are in before the package is bumped
- [ ] Notify the release champ that your changes are in so they can trigger a point-release


## Prep for the _next_ release

- [ ] Create a new [release plan](https://raw.githubusercontent.com/microsoft/vscode-python/main/.github/release_plan.md). (πŸ€–)
Expand Down

0 comments on commit 52b95e2

Please sign in to comment.