Skip to content

Commit

Permalink
(maint) Update New Release Template
Browse files Browse the repository at this point in the history
  • Loading branch information
corbob committed Mar 7, 2024
1 parent daff4a1 commit 324b564
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/zNewRelease.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ For the steps requiring a Chocolatey Team Member, reach out to one of the team m
- [ ] Make sure all issues in the upcoming milestone have only one type label associated (A type label would be labels such as `Feature`, `Improvement`, `Enhancement`, `Bug Fix`, etc).
- [ ] If the GitHub milestone issues are still open, confirm that they are done before moving on. If they are in fact done, apply the `Done` label and close the issue.
- [ ] Update the GitHub milestones description if there is a need for any custom words that should be part of the release notes.
- [ ] TODO: THIS NEEDS UPDATING Run the following command to generate release notes `.\build.bat --target=releasenotes`
- [ ] Run the following command to generate release notes `gitreleasemanager.exe -m <release_version_here> --token $env:GITRELEASEMANAGER_PAT -o chocolatey-community -r chocolatey-au`
- [ ] **NOTE:** This expects that you have GitReleaseManager installed. If you do not, it can be installed with `choco install gitreleasemanager.portable --confirm`
- [ ] **NOTE:** If doing an alpha/beta release, don't run this step, instead generate the release notes manually. GitReleaseManager uses labels and milestones to generate the release notes, and therefore won't understand what needs to be done, especially when there are multiple alpha/beta releases.
- [ ] Before running the above command, make sure you have set the environment variable `GITRELEASEMANAGER_PAT` to your own access token. This can be set through PowerShell with `$env:GITRELEASEMANAGER_PAT = "<token>"`. This token requires access to the labels, milestones, issues, pull requests and releases API.
- [ ] This will generate a new draft release on GitHub - the URL to the release should be output from the above command.
Expand All @@ -47,8 +48,7 @@ For the steps requiring a Chocolatey Team Member, reach out to one of the team m
- [ ] Use GitReleaseManager to close the milestone so that all issues are updated with a message saying this has been released
- [ ] **NOTE:** This step should only be performed if this is a stable release. While on alpha/beta release we don't want to update the issues, since this will happen in the final stable release.
- [ ] Before running the below command, make sure you have set the environment variable `GITRELEASEMANAGER_PAT` to your own access token. This can be set through PowerShell with `$env:GITRELEASEMANAGER_PAT = "<token>"`. This token requires access to the labels, milestones, issues, pull requests and releases API.
TODO: This needs to be updated
- [ ] Use a command similar to the following `tools\GitReleaseManager.0.11.0\tools\GitReleaseManager.exe close -m 0.17.0 --token $env:GITRELEASEMANAGER_PAT -o chocolatey-community -r chocolatey-community-validation`. This should become an automated step at some point in the build process.
- [ ] Use a command similar to the following `gitreleasemanager.exe close -m <release_version_here> --token $env:GITRELEASEMANAGER_PAT -o chocolatey-community -r chocolatey-au`. This should become an automated step at some point in the build process.
- [ ] Once the package is available and approved on Chocolatey Community Repository, announce this release on the public [Discord Server][] under the channel `#community-maintainers` (_There is currently no format for this, but ensure a link to the release notes are included_).
- [ ] Next up, we need to finalise the merging of changes back to the **develop** branch. Depending on what type of release you were performing, the steps are going to be different.
- [ ] If this release comes from the **master** branch:
Expand Down

0 comments on commit 324b564

Please sign in to comment.