Add helper script to create patch releases from cherry-picked commits #6602
Conversation
agoscinski
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #6602 +/- ##
==========================================
+ Coverage 77.51% 77.90% +0.40%
==========================================
Files 560 567 +7
Lines 41444 42147 +703
==========================================
+ Hits 32120 32831 +711
+ Misses 9324 9316 -8 ☔ View full report in Codecov by Sentry. |
|
Thanks a lot, @agoscinski. |
|
I don't think you want a PR being blocked because a test on a developers util fails that is only require for minor releases. That does not make much sense. The moment you need it, it is also tested by usage. |
|
Tests doesn't necessarily need to go in ci, but just have it sort of documented for the expected behavior. |
utils/minor-release.sh
Outdated
| exit 1 | ||
| fi | ||
|
|
||
| # The first argument is the GitHub repo identifier |
There was a problem hiding this comment.
This comment seems outdated since the repo name is hardcoded? (also the one above that mentions that least two arguments are needed)
There was a problem hiding this comment.
True!
| # The first argument is the GitHub repo identifier |
utils/minor-release.sh
Outdated
| else | ||
| echo "Failed to cherry-pick commit $commit" | ||
| # Abort the cherry-pick in case of conflict | ||
| git cherry-pick --abort |
There was a problem hiding this comment.
Since you don't check why the cherry pick failed exactly, maybe the safer thing here would be to just break out of the for loop and let the user deal with the failed cherry pick manually?
More importantly, sometimes the order of commits is important so if one cherry pick fails, it's probably better to stop and don't try to cherry pick any other commits.
There is a description of the file at the top. You can suggest improvements for it. |
|
@agoscinski btw: there is a wiki page 'How to make a release' that would be good to update once you merge this: https://github.com/aiidateam/aiida-core/wiki/How-to-make-a-new-release#3-cherry-picking-commits I guess in general these wiki pages are quite outdated, for example the dependency management quide was still referencing a |
agoscinski
changed the title
agoscinski
force-pushed
the
minor-release-script
branch
from
27fe63e
to
b4c7907
Compare
|
Remember update in commit message minor -> patch release |
Yes, thanks! because the command there was not working as I would like to it to, I made this utility. I will update the wiki once we merge this. |
btw: One idea that I had but didn't have time to mention at the coding week: I wonder if at least some of the documentation in Wiki should be moved into the repo (e.g. as simple markdown files). Otherwise, as we can see, it's very easy for wiki to become outdated, and also it is kinda hidden from sight (perhaps this should be discussed on Discourse not here). The idea comes among other things from the CPython repo, where they recently started to move the devguide into the repo itself, for similar reasons. See: https://github.com/python/cpython/tree/main/InternalDocs |
This is interesting.
The problem is what need to move and what is better to keep in the wiki. @danielhollas you remember that for AiiDAlab we somehow do the opposite to move some guidance to the wiki. |
| cherry_picked_hash=$(git log -1 --pretty=format:"%h" HEAD) | ||
| commit_summaries+=("- $short_commit_message [[${commit}]](https://github.com/$GITHUB_REPO/commit/${original_long_hash})") | ||
| else | ||
| echo "Failed to cherry-pick commit $commit" |
There was a problem hiding this comment.
Maybe this message could be extended to say something about possible next steps? But I am not sure.
There was a problem hiding this comment.
I am also not sure what should be the next step^^ Read the error message and try to fix it is a bit too generic to be useful.
There was a problem hiding this comment.
Agree. Also I guess the person using this script should know what their doing. 😅
Yes, I self assigned myself at the beginning to do this (see issue #6400), but it was too much work and I did not know what is relevant so I postponed this task to the future. |
The script helps with creating a minor release that requires to cherry-pick a list of commits, appends the original commit hash to the cherry-picked commit and creating a short summary of it.
agoscinski
force-pushed
the
minor-release-script
branch
from
b4c7907
to
9b0d0c8
Compare
The script helps with creating a patch release that requires to cherry-pick a list of commits, appends the original commit hash to the cherry-picked commit and creating a short summary of it.
I used it for the v2.6.3 release in PR #6604, so any bugs should be revealed there.