Closed corbob closed 7 months ago
The release process is complete for now. We are waiting on the Chocolatey Package to be moderated, then will complete the remaining steps:
Once that's complete, I will close this issue.
Some notes for the release process that I encountered and may be different from above:
GitReleaseManager.exe create -m 1.0.0 --token $env:GITRELEASEMANAGER_PAT -o chocolatey-community -r chocolatey-au
(#45)BuildAutomation
issue which is excluded from release notes. GRM will not generate release notes if there's nothing to include in them. I have updated #32 to be only an Improvement
and Breaking Change
which will allow us to create the release (and technically the rename is breaking).
Release Procedure
This documents the procedure that should be followed when releasing a new version of the Chocolatey AU project. Most of the steps outlined in this document can be done by anyone with write access to the repository, with the exception of the built artifacts that need to come from a Chocolatey Team Member.
For the steps requiring a Chocolatey Team Member, reach out to one of the team members associated with the repository and ask them for the package artifact once a tag has been created.
build.ps1 -Task CI
locally, to verify that everything builds as expected.Feature
,Improvement
,Enhancement
,Bug Fix
, etc).Done
label and close the issue.gitreleasemanager.exe -m <release_version_here> --token $env:GITRELEASEMANAGER_PAT -o chocolatey-community -r chocolatey-au
choco install gitreleasemanager.portable --confirm
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.git checkout master
ORgit checkout support/*
(NOTE: If you do not have access to push to the master branch, ask a Chocolatey Team Member to be granted bypass access).git merge --no-ff <branch name>
i.e. hotfix/4.1.1 or release/4.2.0, whatever branch you are working on just now.git push upstream
- here upstream is assumed to be the above repository.git push origin
- here origin is assumed to be your fork on the above repositorychoco install chocolatey-au --source="'C:\testing'"
(replaceC:\testing
with the location you sawed the package to) and ensure that it successfully installs (use upgrade if it was already installed).choco uninstall chocolatey-au
and verify the package was successfully uninstalled.chocolatey-au
to the release.5 - Released
with the Done Label.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.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.#community-maintainers
(There is currently no format for this, but ensure a link to the release notes are included).git switch develop
git merge --no-ff master
merge-release-VERSION-change
from develop.git switch develop
git switch -c merge-release-1.2.3-changes
git cherry-pick COMMIT_HASH
(multiple commit hashes may be added).develop
branch on GitHub.git branch -d <hotfix or release branch name>
git push upstream
- here upstream is assumed to be the above repository.git push origin
- here origin is assumed to be your fork off the above repository.appveyor.yml
script, find the mention ofchocolatey-au
and update its version to the released version number.