Skip to content

Commit 0d158a5

Browse files
committed
Stop the release announcement on a failed "Patch Committers" request
dev/release/post-04-website.sh published a partial count if one of the GitHub requests failed. Also document that the script needs an authenticated gh.
1 parent 1d97539 commit 0d158a5

2 files changed

Lines changed: 6 additions & 3 deletions

File tree

‎dev/release/post-04-website.sh‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,8 @@ contributors_command_line="git shortlog -sn ${git_range}"
7979

8080
# Count the pull requests of the commits in ${git_range} by who merged
8181
# them. We ask GitHub because commits merged with the merge button
82-
# don't have "Signed-off-by:" trailers.
82+
# don't have "Signed-off-by:" trailers. A failed request stops the
83+
# script: we must not publish a partial count.
8384
list_committers() {
8485
git log --pretty=%s ${git_range} |
8586
sed -n -E 's/^.* \(#([0-9]+)\)$/\1/p' |
@@ -94,7 +95,8 @@ list_committers() {
9495
query+="}}"
9596
gh api graphql -f query="${query}" \
9697
--jq '.data.repository[].mergedBy | select(. != null) |
97-
if (.name // "") == "" then .login else .name end'
98+
if (.name // "") == "" then .login else .name end' ||
99+
exit 1
98100
done |
99101
sort |
100102
uniq -c |

‎docs/source/developers/release.rst‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -400,7 +400,8 @@ Be sure to go through on the following checklist:
400400
:class-title: sd-fs-5
401401
:class-container: sd-shadow-md
402402

403-
Add a release note for the new version to our website and update the latest release information:
403+
Add a release note for the new version to our website and update the latest release information.
404+
The script needs an authenticated ``gh`` to ask GitHub who merged the pull requests of the release:
404405

405406
.. code-block:: Bash
406407

0 commit comments

Comments
 (0)