Skip to content

tools/changelog-helper: Ignore non-MERGED PRs & ignore already listed PRs faster #2485

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hoffie merged 3 commits into from
Mar 12, 2022
Merged

tools/changelog-helper: Ignore non-MERGED PRs & ignore already listed PRs faster #2485

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3fb0902
tools/changelog-helper: Ignore non-MERGED PRs
hoffie Mar 9, 2022
d95ee8c
tools/changelog-helper: Ignore already listed PRs earlier
hoffie Mar 9, 2022
e92000a
tools/changelog-helper: Make check for existing PRs more robust
hoffie Mar 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions tools/changelog-helper.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,10 +126,17 @@ check_or_add_pr() {
return
fi
checked_ids[$id]=1
local json=$(gh pr view "${id/#/}" --json title,author)
if grep -qE "#$id\>" <<<"$changelog"; then
Copy link
Copy Markdown
Collaborator

@pljones pljones Mar 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a comment on what this does and why, please.

Copy link
Copy Markdown
Collaborator

@pljones pljones Mar 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And, perhaps - like the "not merged" below - echo a message.

Copy link
Copy Markdown
Member Author

@hoffie hoffie Mar 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you add a comment on what this does and why, please.

Done.

And, perhaps - like the "not merged" below - echo a message.

Hm, I'm not convinced. It was generally nice to see that repeated invocations of this script added less and less stuff (e.g. when run again later in the release process). If we generate a line of output of each PR even if it was already there, the output becomes harder to read, IMO. If you feel strongly, I can add it though.

Copy link
Copy Markdown
Collaborator

@pljones pljones Mar 12, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, that's why I was hesitant. Probably best without.

# Changelog already lists this PR ID -> nothing to do
# (\> ensures that we only match full, standalone IDs)
return
fi
local json=$(gh pr view "${id/#/}" --json title,author,state)
local state=$(jq -r .state <<<"${json}")
local title=$(jq -r .title <<<"${json}" | sanitize_title)
local author=$(jq -r .author.login <<<"${json}")
if grep -qF "#$id" <<<"$changelog"; then
if [[ "${state}" != "MERGED" ]]; then
echo "-> Ignoring PR #${id} as state ${state} != MERGED"
return
fi
local title_suggestion_in_pr=$(gh pr view "$id" --json body,comments,reviews --jq '(.body), (.comments[] .body), (.reviews[] .body)' | grep -oP '\bCHANGELOG:\s*\K([^\\]{5,})' | tail -n1 | sanitize_title)
Expand Down