This is an automated email from the ASF dual-hosted git repository. dashorst pushed a commit to branch changelog-github-issues-9.x in repository https://gitbox.apache.org/repos/asf/wicket.git
commit 6014f18f35ac1ae8bbb6d5b8daacf74126faeb2d Author: Martijn Dashorst <[email protected]> AuthorDate: Fri Oct 23 10:15:37 2026 +0200 Include GitHub issues in the release notes built by build-changelog.sh build-changelog.sh built the release notes only from Apache Jira: it looked up the Jira version id on the ReleaseNote.jspa page and copied that page's text release notes into the changelog. Issues are filed on GitHub now, so their fixes never reached the changelog, and a release without a Jira version stopped the script. The page also answers anonymous requests with 401 by now, so the script failed for every version. The script now collects both: - the Jira issues resolved as Fixed with the version as fix version, through the anonymous REST API; a version Jira does not know is skipped instead of failing; - the GitHub issues referenced from the commits since the previous release, as #N, GH-N or an issue URL, either directly or through a pull request that closes them. Issues closed as not planned or as a duplicate are left out. The previous release is the rel/wicket-* tag with the highest version below the one being built; --since overrides it. Release tags are not on the maintenance branches, so the range is taken from the tag rather than from git describe. The repository has no milestones or type labels, so the commits are the only record of which release fixed an issue that needs no bookkeeping. A fix whose commits do not reference its issue is missed, so the script lists the issues closed as completed in the same period that no commit on any branch references, for the release manager to check before it commits. Issues referenced only from another branch are left out of that list: on a maintenance branch they are almost all fixes that were not backported. GitHub issues get the [GH-N] key, which GitHub links by itself, and are grouped by their issue type: Bug, Feature (as New Feature, next to Jira's) or Task. Issues without a type go into an 'Other' group, and the script reports how many there are so their type can be set first. The layout of the notes is unchanged, so release.sh still reads them from /tmp/release-notes-<version>.txt or cuts them from the changelog. Regenerating 10.10.0 gives the same Jira section as the original changelog commit. The script now runs under bash, which it already needed, and needs jq and a GitHub CLI that is logged in. A version given as argument is used as is; the major version is taken from it instead of a pattern that required a qualifier. A changelog that does not exist yet, CHANGELOG-11.x on master, is created, and the diff shown before the commit is taken after staging, so it includes such a new file. GitHub issue #1699 Generated-by: Claude Code (Claude Opus 5.5) (cherry picked from commit 153eda1dcc53afac4db74223a2cf0232062d0494) --- build-changelog.sh | 260 ++++++++++++++++++++++++++++++++++++++++++----------- 1 file changed, 209 insertions(+), 51 deletions(-) diff --git a/build-changelog.sh b/build-changelog.sh index 22f487f8f1..0d622f71ae 100755 --- a/build-changelog.sh +++ b/build-changelog.sh @@ -1,4 +1,4 @@ -#!/bin/sh +#!/bin/bash # Licensed to the Apache Software Foundation (ASF) under one or more # contributor license agreements. See the NOTICE file distributed with # this work for additional information regarding copyright ownership. @@ -14,8 +14,14 @@ # See the License for the specific language governing permissions and # limitations under the License. +jira_project=WICKET +jira_url=https://issues.apache.org/jira/rest/api/2 +github_owner=apache +github_name=wicket +github_repository=$github_owner/$github_name + function fail { - echo "$1" + echo "$1" >&2 exit 1 } @@ -26,49 +32,149 @@ xpath /pom:project/pom:version/text() EOF } +# Prints one record per GitHub issue resolved by the given issue and pull request numbers: a pull +# request contributes the issues it closes. +function getGitHubIssues { + local query="query { repository(owner: \"$github_owner\", name: \"$github_name\") {" + for number in "$@" ; do + query+=" n$number: issueOrPullRequest(number: $number) { ...issueOrPullRequest }" + done + query+=" } } +fragment issue on Issue { number title url stateReason issueType { name } } +fragment issueOrPullRequest on IssueOrPullRequest { + ... on Issue { ...issue } + ... on PullRequest { closingIssuesReferences(first: 25) { nodes { ...issue } } } +}" + + # a number that is no issue or pull request fails gh, but leaves the others in the response + local response + response=$(gh api graphql -f query="$query" 2> /dev/null) + jq -e '.data.repository' <<< "$response" > /dev/null \ + || fail "Unable to retrieve the issues from GitHub: $response" + + jq -r --arg url "https://github.com/$github_repository/issues/"; ' + .data.repository[] + | select(. != null) + | if has("closingIssuesReferences") then .closingIssuesReferences.nodes[] else . end + | select(.url | startswith($url)) + | select(.stateReason != "NOT_PLANNED" and .stateReason != "DUPLICATE") + | [ + (.issueType.name | if . == null then "Other" elif . == "Feature" then "New Feature" else . end), + "2", + (.number | tostring), + "GH-\(.number)", + (.title | gsub("\\s+"; " ") | sub(" $"; "")) + ] + | join("\t")' <<< "$response" +} + +# Prints one record per GitHub issue referenced from the commit messages that git log selects with +# the given arguments. +function getReferencedGitHubIssues { + local references + references=$(git log --format=%B "$@" \ + | grep -oE "([[:alnum:]_.-]+/[[:alnum:]_.-]+)?#[0-9]+|GH-[0-9]+|github\.com/[[:alnum:]_.-]+/[[:alnum:]_.-]+/(issues|pull)/[0-9]+" \ + | grep -E "^(#|GH-|$github_repository#|github\.com/$github_repository/)" \ + | grep -oE '[0-9]+$' \ + | sort -n -u) + echo $references | xargs -n 50 | while read -r numbers ; do + [ -n "$numbers" ] || continue + getGitHubIssues $numbers || exit 1 + done | sort -u + return ${PIPESTATUS[2]} +} + if [ "$1" = "--help" ] ; then echo " -Usage: $0 [--help] [version] +Usage: $0 [--help] [--since <ref>] [version] -Retrieves the release notes for the next release of Apache Wicket, -and merges this into the CHANGELOG file. +Collects the issues resolved in the next release of Apache Wicket from +JIRA and GitHub, and merges them into the CHANGELOG file. version - optional version number to retrieve the release notes for + optional version number to collect the release notes for, defaults + to the version in the pom without its bugfix and snapshot parts + + --since <ref> + git reference of the previous release, defaults to the tag of the + highest version before this one --help shows this help +The JIRA issues are the ones resolved as Fixed with the version as fix +version. The GitHub issues are the ones referenced from the commits since +the previous release, either directly or through a pull request that +closes them; a GitHub issue closed as not planned or as a duplicate is +left out. The issue type of a GitHub issue decides its group, and an issue +without one goes into 'Other'. + +Needs curl, jq, xmllint and an authenticated GitHub CLI (gh auth login). " exit 0 fi -if [ ! -z "$1" ] ; then - current_version="$1" - major_version=$(expr $current_version : '\(.*\)\..*\..*\-.*') - minor_version=$(expr $current_version : '.*\.\(.*\)\..*\-.*') - bugfix_version=$(expr $current_version : '.*\..*\.\(.*\)-.*') - - version="$1" - previous_version="$major_version.$(expr $minor_version - 1).0" -else +since_ref="" +version="" +while [ $# -gt 0 ] ; do + case "$1" in + --since) + [ -n "$2" ] || fail "--since needs a git reference" + since_ref="$2" + shift + ;; + -*) + fail "Unknown option: $1, see $0 --help" + ;; + *) + version="$1" + ;; + esac + shift +done + +for tool in curl jq gh xmllint ; do + command -v $tool > /dev/null || fail "$tool is required to build the release notes" +done +gh auth status --hostname github.com > /dev/null 2>&1 \ + || fail "The GitHub CLI is not logged in to github.com, run: gh auth login" + +if [ -z "$version" ] ; then current_version=$(getProjectVersionFromPom) major_version=$(expr $current_version : '\(.*\)\..*\..*\-.*') minor_version=$(expr $current_version : '.*\.\(.*\)\..*\-.*') - bugfix_version=$(expr $current_version : '.*\..*\.\(.*\)-.*') version="$major_version.$minor_version.0" - previous_version="$major_version.$(expr $minor_version - 1).0" fi +major_version=${version%%.*} -echo " +if git rev-parse -q --verify "refs/tags/rel/wicket-$version" > /dev/null ; then + until_ref="rel/wicket-$version" +else + until_ref=HEAD +fi + +if [ -z "$since_ref" ] ; then + previous_version=$( \ + { git tag -l 'rel/wicket-*' | sed -e 's|^rel/wicket-||' ; echo "$version" ; } \ + | sort -V -u \ + | awk -v version="$version" '$0 == version { print previous; exit } { previous = $0 }' \ + ) + [ -n "$previous_version" ] \ + || fail "No release tag found before $version: fetch the tags (git fetch --tags) or use --since" + since_ref="rel/wicket-$previous_version" +fi +git rev-parse -q --verify "$since_ref^{commit}" > /dev/null || fail "Unknown git reference: $since_ref" + +printf "%s" " Apache Wicket release notes generator ===================================== -This tool retrieves the release notes for the upcoming release from JIRA -and merges this with the existing CHANGELOG in a text format. +This tool collects the issues resolved in the upcoming release from JIRA +and GitHub, and merges them with the existing CHANGELOG in a text format. -Version to retrieve the release notes from: $version +Version to collect the release notes for: $version +Commits searched for GitHub issues: $since_ref..$until_ref -Press <enter> to continue \c" +Press <enter> to continue " read @@ -78,44 +184,96 @@ if [ $? -eq 0 ] ; then " fi -grep -q "$version\$" CHANGELOG-$major_version.x +grep -q "$version\$" CHANGELOG-$major_version.x 2> /dev/null if [ $? -eq 0 ] ; then fail "You already have added release notes for this version to the changelog. " fi +issues=/tmp/release-issues-$version.tsv +: > $issues echo " -Extracting JIRA Release notes -- making web requests" -echo " - determining JIRA version id for $version: \c" -jira_project_id=12310561 -jira_version_id=$( \ - curl -s https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=$jira_project_id \ - | xmllint --noout --noblanks --html --xpath "string(//select[@id=\"version_select\"]/option[translate(normalize-space(text()), ' ', '')=\"$version\"]/@value)" - 2>/dev/null \ - ) - -re='^[0-9]+$' -if ! [[ $jira_version_id =~ $re ]] ; then - echo "ERROR" - echo " -Unable to retrieve the version ID from JIRA: received '$jira_version_id'" >&2 - exit 1 +Collecting the resolved issues -- making web requests" +printf " - retrieving JIRA issues fixed in %s: " "$version" +jira_versions=$(curl -sf "$jira_url/project/$jira_project/versions") \ + || fail "Unable to retrieve the versions from JIRA" +if jq -e --arg version "$version" 'any(.[]; .name == $version)' <<< "$jira_versions" > /dev/null ; then + jira_issues=$(curl -sf -G "$jira_url/search" \ + --data-urlencode "jql=project = $jira_project AND fixVersion = \"$version\" AND resolution = Fixed" \ + --data-urlencode "fields=issuetype,summary" \ + --data-urlencode "maxResults=1000") \ + || fail "Unable to retrieve the issues fixed in $version from JIRA" + jq -e '.total == (.issues | length)' <<< "$jira_issues" > /dev/null \ + || fail "JIRA returned only part of the issues fixed in $version" + jq -r '.issues[] + | [ + .fields.issuetype.name, + "1", + (.key | sub("^[A-Z]+-"; "")), + .key, + (.fields.summary | gsub("\\s+"; " ") | sub(" $"; "")) + ] + | join("\t")' <<< "$jira_issues" >> $issues + jq '.issues | length' <<< "$jira_issues" +else + echo "none, JIRA has no version $version" fi -echo "$jira_version_id" +printf " - retrieving GitHub issues referenced since %s: " "$since_ref" +github_issues=$(getReferencedGitHubIssues "$since_ref..$until_ref") || exit 1 +[ -n "$github_issues" ] && echo "$github_issues" >> $issues +echo "$github_issues" | grep -c . -echo " - retrieving text release notes: \c" -curl -s "https://issues.apache.org/jira/secure/ReleaseNote.jspa?projectId=$jira_project_id&version=$jira_version_id&styleName=Text&Create=Create"; \ - | xmllint --noout --noblanks --html --xpath "string(//textarea)" - 2>/dev/null | cat -s | awk '{ if ($0 ~ /^\*\* / ) { - printf( "%s\n\n", $0); -} else { - printf( "%s\n", $0 ); -} -}' > /tmp/release-notes-$version.txt +printf " - checking for GitHub issues closed without a reference: " +since_date=$(git log -1 --format=%cs "$since_ref") +closed="closed:>=$since_date" +if [ "$until_ref" != HEAD ] ; then + closed="closed:$since_date..$(git log -1 --format=%cs "$until_ref")" +fi +referenced_anywhere=$(getReferencedGitHubIssues --all --since="$since_date") || exit 1 +unreferenced=$(gh issue list --repo $github_repository --state closed --limit 1000 \ + --search "$closed reason:completed" --json number,title \ + --jq '.[] | "GH-\(.number)\t\(.title)"' \ + | grep -v -F -f <({ cut -f4 $issues ; echo "$referenced_anywhere" | cut -f4 ; } | grep . | sed -e 's/$/\t/')) +echo "$unreferenced" | grep -c . + +[ -s $issues ] || fail " +No resolved issues found for $version in JIRA or GitHub" -echo "done" +awk -F '\t' ' + BEGIN { + count = split("Sub-task,Bug,New Feature,Improvement,Test,Wish,Task", groups, ",") + for (i = 1; i <= count; i++) order[groups[i]] = i + } + { print ($1 in order ? order[$1] : ($1 == "Other" ? 99 : 50)) "\t" $0 }' $issues \ + | sort -t $'\t' -u -k1,1n -k2,2 -k3,3n -k4,4n \ + | awk -F '\t' -v version="$version" ' + BEGIN { print ""; print "Release Notes - Wicket - Version " version; print "" } + $2 != group { if (group != "") print ""; print "** " $2; print ""; group = $2 } + { print " * [" $5 "] - " $6 }' > /tmp/release-notes-$version.txt -echo " - merging release notes into changelog: \c" +untyped=$(grep -c $'^Other\t' $issues) +if [ -n "$unreferenced" ] || [ "$untyped" -gt 0 ] ; then + echo "" + if [ "$untyped" -gt 0 ] ; then + echo "GitHub issues without an issue type: $untyped. They are listed under 'Other'; set +their type (Bug, Feature or Task) on GitHub and run this tool again to group them." + echo "" + fi + if [ -n "$unreferenced" ] ; then + echo "These GitHub issues were closed as completed in the same period, but no commit on +any branch references them, so they are not in the release notes. To add one that was fixed +in this release, edit the changelog afterwards and amend the commit: +" + echo "$unreferenced" | sed -e 's/^/ /' + echo "" + fi + printf "Press <enter> to continue, or Ctrl-C to stop " + read +fi + +printf " - merging release notes into changelog: " echo "This file contains all changes done in releases for Apache Wicket $major_version.x. @@ -123,17 +281,17 @@ echo "This file contains all changes done in releases for Apache Wicket $major_v $(cat /tmp/release-notes-$version.txt) ======================================================================= -$(tail -n +4 CHANGELOG-$major_version.x) +$(tail -n +4 CHANGELOG-$major_version.x 2> /dev/null) " > /tmp/changelog-$version.txt cp /tmp/changelog-$version.txt CHANGELOG-$major_version.x echo "done " -git diff +git add CHANGELOG-$major_version.x +git diff --cached echo "" -git add CHANGELOG-$major_version.x git commit -m "Added CHANGELOG for release $version" echo "
