Initial contributor list script

stephenking314 · stephenking314 · commit 3fa284c37f1e · 2026-06-10T16:06:03.000-07:00
Generate contributor list and compare url for github release notes.

The goal of this change is to fully automate the generation of github
releases removing an error prone, tedious, manual step.

Additionally this includes a minor readability update for the render
notes script.
diff --git a/.github/workflows/shippable_builds.yml b/.github/workflows/shippable_builds.yml
@@ -207,8 +207,8 @@ jobs:
     outputs:
       k9mail_sha: ${{ steps.commit.outputs.k9mail_sha }}
       thunderbird_sha: ${{ steps.commit.outputs.thunderbird_sha }}
-      k9mail_github_notes: ${{ steps.render_notes.outputs.k9mail_github_notes }}
-      thunderbird_github_notes: ${{ steps.render_notes.outputs.thunderbird_github_notes }}
+      k9mail_github_notes: ${{ steps.append_contributors.outputs.k9mail_github_notes }}
+      thunderbird_github_notes: ${{ steps.append_contributors.outputs.thunderbird_github_notes }}
       old_version_code: ${{ steps.new_version_code.outputs.old_version_code }}
       new_version_code: ${{ steps.new_version_code.outputs.new_version_code }}
     steps:
@@ -415,6 +415,53 @@ jobs:
           echo "${APP_NAME}_sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
           echo "sha=$(git rev-parse HEAD)" >> $GITHUB_OUTPUT
 
+      - name: Append Contributors
+        id: append_contributors
+        if: "${{ contains(matrix.releaseTarget, 'github') && contains(fromJSON('[\"beta\", \"release\"]'), needs.dump_config.outputs.releaseType) }}"
+        shell: bash
+        env:
+          APP_NAME: ${{ matrix.appName }}
+          RELEASE_TYPE: ${{ vars.RELEASE_TYPE }}
+          APPLICATION_LABEL: ${{ steps.appinfo.outputs.APPLICATION_LABEL }}
+          VERSION_CODE: ${{ steps.new_version_code.outputs.new_version_code }}
+          FULL_VERSION_NAME: ${{ steps.appinfo.outputs.VERSION_NAME }}${{ steps.bump_version_suffix.outputs.SUFFIX || steps.appinfo.outputs.VERSION_NAME_SUFFIX }}
+          K9MAIL_GITHUB_NOTES: ${{ steps.render_notes.outputs.k9mail_github_notes }}
+          THUNDERBIRD_GITHUB_NOTES: ${{ steps.render_notes.outputs.thunderbird_github_notes }}
+        run: |
+          case "${APP_NAME}:${RELEASE_TYPE}" in
+            thunderbird:beta) TAG_REGEX='^THUNDERBIRD_[0-9]+_0b[0-9]+$'
+                              GITHUB_NOTES=$THUNDERBIRD_GITHUB_NOTES
+                              ;;
+            thunderbird:*) TAG_REGEX='^THUNDERBIRD_[0-9]+_[0-9]+$'
+                           GITHUB_NOTES=$THUNDERBIRD_GITHUB_NOTES
+                           ;;
+            k9mail:*) TAG_REGEX='^K9MAIL_[0-9]+_[0-9]+$'
+                      GITHUB_NOTES=$K9MAIL_GITHUB_NOTES
+                      ;;
+          esac
+
+          TAG_NAME="${APP_NAME^^}_${FULL_VERSION_NAME//./_}"
+          NOTES_FILE="$(mktemp -d)/github_notes.txt"
+          CONTRIBUTORS_FILE="$(mktemp -d)/contributors.txt"
+          echo "${GITHUB_NOTES}" >> "${NOTES_FILE}"
+
+          python ./scripts/ci/contributor_list.py \
+            --regex "$TAG_REGEX" \
+            --head "HEAD" \
+            --changelog-head "$TAG_NAME" \
+          "$CONTRIBUTORS_FILE"
+
+          cat "${CONTRIBUTORS_FILE}" >> "${NOTES_FILE}"
+
+          echo "${APP_NAME}_github_notes<<EOF" >> $GITHUB_OUTPUT
+          cat $NOTES_FILE >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+
+          echo "<h2>${APPLICATION_LABEL} ${FULL_VERSION_NAME} Contributors (${VERSION_CODE})</h2>" | tee -a $GITHUB_STEP_SUMMARY
+          echo -e "\n\n\`\`\`" | tee -a $GITHUB_STEP_SUMMARY
+          cat $CONTRIBUTORS_FILE | tee -a $GITHUB_STEP_SUMMARY
+          echo -e "\`\`\`" | tee -a $GITHUB_STEP_SUMMARY
+
       - name: Summary
         if: ${{ contains(matrix.releaseTarget, 'github') || needs.dump_config.outputs.releaseType == 'daily' }}
         uses: actions/github-script@3a2844b7e9c422d3c10d287c895573f7108da1b3 # v9.0.0
diff --git a/scripts/ci/contributor_list.py b/scripts/ci/contributor_list.py
@@ -0,0 +1,182 @@
+#!/usr/bin/env python3
+import argparse
+import os
+import subprocess
+import sys
+import requests
+import re
+
+
+def git(*args):
+    return subprocess.check_output(["git", *args], text=True).strip()
+
+
+def get_recent_matching_tags(pattern):
+    output = git(
+        "for-each-ref",
+        "--sort=-creatordate",
+        "--format=%(refname:short)",
+        "refs/tags",
+    )
+    filtered = [line for line in output.splitlines() if re.search(pattern, line)]
+    return filtered[:2]
+
+
+def github_get(url):
+    headers = {
+        "Accept": "application/vnd.github+json",
+        "User-Agent": "contributors-between-tags",
+    }
+    token = os.getenv("GITHUB_TOKEN")
+    if token:
+        headers["Authorization"] = f"Bearer {token}"
+
+    response = requests.get(url, headers=headers)
+    response.raise_for_status()
+
+    return response
+
+
+def github_compare(older, newer):
+    commits = []
+
+    url = f"https://api.github.com/repos/thunderbird/thunderbird-android/compare/{older}...{newer}?per_page=100"
+
+    while True:
+        response = github_get(url)
+        data = response.json()
+
+        page_commits = data.get("commits", [])
+        commits.extend(page_commits)
+
+        if "next" in response.links:
+            url = response.links["next"]["url"]
+        else:
+            break
+
+    return commits
+
+
+def get_contributors(commits):
+    contributors = {}
+    for commit in commits:
+        author = commit.get("author")
+
+        if not author or not author.get("login"):
+            continue
+
+        author = commit.get("author").get("login")
+        date = commit.get("commit").get("author").get("date")
+
+        # Track the earliest commit of each author in this set
+        if author not in contributors:
+            contributors[author] = commit
+        elif date < contributors[author].get("commit").get("author").get("date"):
+            contributors[author] = commit
+
+    return contributors
+
+
+def is_first_commit(author, date):
+    url = f"https://api.github.com/repos/thunderbird/thunderbird-android/commits?author={author}&until={date}&per_page=2"
+    data = github_get(url).json()
+    return len(data) == 1
+
+
+def get_first_contributions(contributors):
+    first_contributions = {}
+    for author, commit in contributors.items():
+        date = commit.get("commit").get("author").get("date")
+        if is_first_commit(author, date):
+            sha = commit.get("sha")
+            url = f"https://api.github.com/repos/thunderbird/thunderbird-android/commits/{sha}/pulls"
+            commit_data = github_get(url).json()
+            if commit_data and "number" in commit_data[0]:
+                pr_num = commit_data[0].get("number")
+                first_contributions[author] = f"#{pr_num}"
+
+    return first_contributions
+
+
+def generate_contributor_list(
+        regex,
+        head,
+        changelog_head,
+        output_file
+):
+    tags = get_recent_matching_tags(regex)
+
+    if head:
+        if len(tags) < 1:
+            print(f"Not enough tags matching pattern: {regex}", file=sys.stderr)
+            sys.exit(1)
+
+        older = tags[0]
+        newer = head
+        changelog_newer = changelog_head or head
+    else:
+        if len(tags) < 2:
+            print(f"Not enough tags matching pattern: {regex}", file=sys.stderr)
+            sys.exit(1)
+
+        newer, older = tags[0], tags[1]
+        changelog_newer = newer
+
+    commits = github_compare(older, newer)
+    contributors = get_contributors(commits)
+
+    # Don't include bots in contributor list
+    for bot in {'dependabot[bot]', 'thunderbird-botmobile[bot]', 'weblate'}:
+        contributors.pop(bot, None)
+
+    first_contributions = get_first_contributions(contributors)
+    contributors = {f"@{author}" for author in contributors}
+
+    with open(output_file, "w", encoding='utf-8') as f:
+        print("\nContributors:", file=f)
+        thanks_to = "Thanks to: " + ', '.join(sorted(contributors, key=str.casefold))
+        print(thanks_to, file=f)
+
+        if first_contributions:
+            print("\nNew Contributors:", file=f)
+            for author, pr in first_contributions.items():
+                print(f"* @{author} made their first contribution in {pr}", file=f)
+
+        changelog = f"https://github.com/thunderbird/thunderbird-android/compare/{older}...{changelog_newer}"
+        print(f'\n**Full Changelog**: {changelog}', file=f)
+
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument(
+        "--head",
+        help="Ref/SHA to compare against the latest matching tag"
+    )
+    parser.add_argument(
+        "--changelog-head",
+        help="Ref/tag to use in the Full Changelog link"
+    )
+    parser.add_argument(
+        "--regex",
+        "-r",
+        default=r"^THUNDERBIRD_\d+_\d+$",
+        help="Regex Pattern to use to search recent tags",
+    )
+    parser.add_argument(
+        "output_file",
+        type=str,
+        nargs="?",
+        default="contributors",
+        help="File to render contributors to",
+    )
+    args = parser.parse_args()
+
+    generate_contributor_list(
+        args.regex,
+        args.head,
+        args.changelog_head,
+        args.output_file
+    )
+
+if __name__ == "__main__":
+    main()
diff --git a/scripts/ci/render-notes.py b/scripts/ci/render-notes.py
@@ -124,33 +124,33 @@ def render_notes(
 
     template_base = os.path.join(os.path.dirname(sys.argv[0]), "templates")
 
-    for render_file in render_files:
-        with open(os.path.join(template_base, render_files[render_file]["template"]), "r") as file:
+    for render_file, config in render_files.items():
+        with open(os.path.join(template_base, config["template"]), "r") as file:
             template = file.read()
-        template = Template(template, autoescape=render_files[render_file].get("autoescape", False))
-        rendered = template.render(render_files[render_file]["render_data"])
+        template = Template(template, autoescape=config.get("autoescape", False))
+        rendered = template.render(config["render_data"])
         if render_file == "changelog_master":
             if print_only:
-                print(f"\n==={render_files[render_file]['outfile']}===")
+                print(f"\n==={config['outfile']}===")
                 print("...")
                 print(rendered)
                 print("...")
             else:
-                with open(render_files[render_file]["outfile"], "r") as file:
+                with open(config["outfile"], "r") as file:
                     lines = file.readlines()
                     for index, line in enumerate(lines):
                         if "<changelog>" in line:
                             if version in lines[index + 1]:
                                 break
                             lines.insert(index + 1, rendered)
                             break
-                with open(render_files[render_file]["outfile"], "w") as file:
+                with open(config["outfile"], "w") as file:
                     file.writelines(lines)
         elif render_file == "changelog" or render_file == "changelog_long":
             stripped = rendered.lstrip()
-            maxlen = render_files[render_file].get("max_length", float("inf"))
+            maxlen = config.get("max_length", float("inf"))
             if print_only:
-                print(f"\n==={render_files[render_file]['outfile']}===")
+                print(f"\n==={config['outfile']}===")
                 print(stripped)
 
             if len(stripped) > maxlen:
@@ -160,7 +160,7 @@ def render_notes(
                 sys.exit(1)
 
             if not print_only:
-                with open(render_files[render_file]["outfile"], "x") as file:
+                with open(config["outfile"], "x") as file:
                     file.write(stripped)
 
 
diff --git a/scripts/test_python_scripts.sh b/scripts/test_python_scripts.sh
@@ -54,6 +54,7 @@ echo ""
 python3 -m py_compile "$SCRIPT_DIR/ci/render-notes.py" && echo "  ✓ render-notes.py"
 python3 -m py_compile "$SCRIPT_DIR/ci/setup_release_automation" && echo "  ✓ setup_release_automation"
 python3 -m py_compile "$SCRIPT_DIR/ci/merges/merge_gradle.py" && echo "  ✓ merge_gradle.py"
+python3 -m py_compile "$SCRIPT_DIR/ci/contributor_list.py" && echo "  ✓ contributor_list.py"
 
 echo ""
 echo "✓ All tests passed!"
