Update the RELEASE.md file with the latest instructions #2239
Conversation
diegolovison
force-pushed
the
improve_release
branch
from
a18e58b to
60d7a3f
Compare
There was a problem hiding this comment.
Hi @diegolovison, overall looks great!
I left just a couple of changes that I think it would be great to have
Co-authored-by: Andrea Lamparelli <[email protected]>
Co-authored-by: Andrea Lamparelli <[email protected]>
|
Accepted the suggestion by doing the commit via UI. I think it will be good to Squash and Merge. I don't know if you will be kept as author. I only would like to not have 3 commits for a single change. Thanks |
|
|
||
| if the proper credentials are in place. | ||
| The only missing step is the creation of the GitHub release, a step that at the moment needs to be done manually using the GitHub UI. Consider using the “Generate release notes” feature to pre-populate the release notes automatically after selecting the correct tags. |
There was a problem hiding this comment.
“Generate release notes” works well for point releases, but not for the first 0.x.0 release, the first time a new stable branch is released. This is due to us backporting commits to the previous stable branch, where features/fixes will have been backported to the 0.x-1.0 branch with a different commit hash.
We have not thought about how we can improve this, and atm for the first release from a new branch, we also have to manually remove the commits that had been backported from the release notes
There was a problem hiding this comment.
+1, unfortunately this seems a drawback of releasing from a stable branch where we cherry-pick commits (that, as you already highlighted, have different SHAs).
Not sure whether we should add this clarification in the RELEASE.md doc 🫤
There was a problem hiding this comment.
IMHO, we should add what was mentioned. @johnaohara would you like to open a PR?
Fixes Issue
Closes #2165
Changes proposed
Update the
RELEASE.mdfile with the latest instructions. Due to that previous content was entirely removed. It will be easy to review if you open the rendered version in a new tab.Check List (Check all the applicable boxes)