In the before times, when we had a manually created push-doc for each weekly/fortnightly deployment we did the following:
there was a doc created for, say, the deployment planned on 2024-08-02. It had links to compare the expected tag compared to the most recent tags on prod.
Any time there was a need for special notes for SRE, operations, engineering, etc the doc would be edited.
if there was a cherry pick needed after the 2024.08.22 tag was created, but before the 2024.08.22 tag was deployed to prod by SRE, the doc would be updated with details of the cherry-picked commit, and the compare links updated to the new tag (e.g. 2024.08.22-1 - real example)
if there was a cherry pick needed after the tag was deployed to prod (aka chemspill release) then we sometimes created a new doc, but generally reused the existing doc, and updated it with the details of the cherry-pick
if there was a cherry-pick, but for a planned off-schedule release, we generally created a new doc named for that date.
in each case we manually updated a link, pointing directly to the current push doc in the #remora channel header, so it was clear to SRE (and us) what was being deployed to prod next.
Now...
A draft release is created via a github action that creates a new release, and prefills the notes with the push doc template.
The draft release can be edited to add special notes.
The release is edited after the tag has been created (e.g. 2024.08.22) to link to the tag. There is a button to generate a full changelog from tag, compared to a previous tag, and append it to the bottom of the release notes. The release has to be published to start the deployment pipeline to AMO stage.
if there was a cherry pick needed after the 2024.08.22 tag was created, but before the 2024.08.22 tag was deployed to prod by SRE then we need to create a new separate release and publish it to start the deployment.
But what to have in the release notes for that new release? link to commit? link to the previous release? push doc template but empty? full changelog again? what about any special notes?
What do we do with the previous release and it's notes?
similarly, for a cherry pick release after the tag was deployed to prod (aka chemspill release), or an off-schedule release, there is a need for a new release to be created on github, with new notes. What should they contain?
Description
In the before times, when we had a manually created push-doc for each weekly/fortnightly deployment we did the following:
Now...
Acceptance Criteria
Checks
┆Issue is synchronized with this Jira Task