build: update license workflow

Author: K4thos

.github/scripts/update_licence_contributors.py

@@ -0,0 +1,230 @@
+#!/usr/bin/env python3
+"""Generate the LICENCE.txt copyright block from merged pull requests."""
+
+from __future__ import annotations
+
+import json
+import os
+import re
+import sys
+import urllib.error
+import urllib.request
+from collections import defaultdict
+from datetime import datetime, timezone
+from pathlib import Path
+from typing import TypedDict
+
+
+BASE_BRANCH = "develop"
+MIN_MERGED_PULL_REQUESTS = 2
+MIN_ADDITIONS = 100
+MANUAL_CONTRIBUTORS = {"Suehiro": 2016}
+EXCLUDED_LOGINS = {"lint-action", "ppitulaj"}
+
+QUERY = """
+query($owner: String!, $name: String!, $branch: String!, $cursor: String) {
+  repository(owner: $owner, name: $name) {
+    pullRequests(
+      first: 100
+      after: $cursor
+      states: [MERGED]
+      baseRefName: $branch
+    ) {
+      pageInfo { hasNextPage endCursor }
+      nodes {
+        additions
+        mergedAt
+        author { __typename login }
+      }
+    }
+  }
+}
+"""
+
+
+class Stats(TypedDict):
+    login: str
+    pull_requests: int
+    additions: int
+    first_merged_at: str
+
+
+def graphql(token: str, variables: dict[str, object]) -> dict:
+    request = urllib.request.Request(
+        "https://api.github.com/graphql",
+        data=json.dumps({"query": QUERY, "variables": variables}).encode(),
+        headers={
+            "Accept": "application/vnd.github+json",
+            "Authorization": f"Bearer {token}",
+            "Content-Type": "application/json",
+            "User-Agent": "ikemen-go-licence-generator",
+        },
+        method="POST",
+    )
+
+    try:
+        with urllib.request.urlopen(request, timeout=60) as response:
+            result = json.load(response)
+    except urllib.error.HTTPError as exc:
+        details = exc.read().decode("utf-8", errors="replace")
+        raise RuntimeError(f"GitHub API returned HTTP {exc.code}: {details}") from exc
+    except urllib.error.URLError as exc:
+        raise RuntimeError(f"GitHub API request failed: {exc}") from exc
+
+    if result.get("errors"):
+        raise RuntimeError(f"GitHub API returned errors: {result['errors']}")
+    return result["data"]
+
+
+def fetch_stats(token: str, owner: str, repository_name: str) -> dict[str, Stats]:
+    stats: dict[str, Stats] = {}
+    excluded = {login.casefold() for login in EXCLUDED_LOGINS}
+    cursor: str | None = None
+
+    while True:
+        data = graphql(
+            token,
+            {
+                "owner": owner,
+                "name": repository_name,
+                "branch": BASE_BRANCH,
+                "cursor": cursor,
+            },
+        )
+        repository = data.get("repository")
+        if repository is None:
+            raise RuntimeError(f"Repository {owner}/{repository_name} was not found")
+
+        pull_requests = repository["pullRequests"]
+        for pull_request in pull_requests["nodes"]:
+            author = pull_request["author"]
+            merged_at = pull_request["mergedAt"]
+            if author is None or merged_at is None:
+                continue
+
+            login = author["login"]
+            key = login.casefold()
+            if (
+                author["__typename"] == "Bot"
+                or key.endswith("[bot]")
+                or key in excluded
+            ):
+                continue
+
+            contributor = stats.setdefault(
+                key,
+                {
+                    "login": login,
+                    "pull_requests": 0,
+                    "additions": 0,
+                    "first_merged_at": merged_at,
+                },
+            )
+            contributor["login"] = login
+            contributor["pull_requests"] += 1
+            contributor["additions"] += pull_request["additions"]
+            contributor["first_merged_at"] = min(
+                contributor["first_merged_at"],
+                merged_at,
+            )
+
+        page_info = pull_requests["pageInfo"]
+        if not page_info["hasNextPage"]:
+            return stats
+        cursor = page_info["endCursor"]
+
+
+def qualifies(contributor: Stats) -> bool:
+    return (
+        contributor["pull_requests"] >= MIN_MERGED_PULL_REQUESTS
+        and contributor["additions"] >= MIN_ADDITIONS
+    )
+
+
+def generate_notice(stats: dict[str, Stats]) -> tuple[str, list[Stats], list[Stats]]:
+    included = [contributor for contributor in stats.values() if qualifies(contributor)]
+    skipped = [contributor for contributor in stats.values() if not qualifies(contributor)]
+    names_by_year: dict[int, list[str]] = defaultdict(list)
+
+    for login, year in MANUAL_CONTRIBUTORS.items():
+        names_by_year[year].append(login)
+
+    manual_logins = {login.casefold() for login in MANUAL_CONTRIBUTORS}
+    for contributor in included:
+        if contributor["login"].casefold() not in manual_logins:
+            year = int(contributor["first_merged_at"][:4])
+            names_by_year[year].append(contributor["login"])
+
+    lines = []
+    for year in sorted(names_by_year):
+        names = sorted(set(names_by_year[year]), key=str.casefold)
+        lines.append(f"Copyright (c) {year} {', '.join(names)}")
+
+    current_year = datetime.now(timezone.utc).year
+    lines.append(f"Copyright (c) 2016-{current_year} Ikemen GO contributors")
+    return "\n".join(lines), included, skipped
+
+
+def update_licence(notice: str) -> bool:
+    path = Path("LICENCE.txt")
+    text = path.read_text(encoding="utf-8")
+    pattern = re.compile(
+        r"\AMIT License\r?\n\r?\n"
+        r"(?:Copyright \(c\)[^\r\n]*\r?\n)+"
+        r"\r?\n(?=Permission is hereby granted)",
+    )
+    updated, replacements = pattern.subn(
+        f"MIT License\n\n{notice}\n\n",
+        text,
+        count=1,
+    )
+    if replacements != 1:
+        raise RuntimeError("Could not find the copyright block in LICENCE.txt")
+    if updated == text:
+        return False
+
+    path.write_text(updated, encoding="utf-8", newline="\n")
+    return True
+
+
+def print_audit(included: list[Stats], skipped: list[Stats]) -> None:
+    print(
+        f"Policy: >= {MIN_MERGED_PULL_REQUESTS} merged PRs to {BASE_BRANCH} "
+        f"and >= {MIN_ADDITIONS} cumulative additions."
+    )
+    for heading, contributors in (
+        ("Included", included),
+        ("Covered only by the collective notice", skipped),
+    ):
+        print(f"\n{heading}:")
+        for contributor in sorted(contributors, key=lambda item: item["login"].casefold()):
+            year = contributor["first_merged_at"][:4]
+            print(
+                f"  {contributor['login']}: {contributor['pull_requests']} PRs, "
+                f"{contributor['additions']} additions, first merged {year}"
+            )
+
+
+def main() -> int:
+    token = os.environ.get("GITHUB_TOKEN")
+    repository = os.environ.get("GITHUB_REPOSITORY", "ikemen-engine/Ikemen-GO")
+    if not token:
+        print("GITHUB_TOKEN is required", file=sys.stderr)
+        return 2
+
+    try:
+        owner, repository_name = repository.split("/", 1)
+        stats = fetch_stats(token, owner, repository_name)
+        notice, included, skipped = generate_notice(stats)
+        changed = update_licence(notice)
+    except (RuntimeError, ValueError, KeyError) as exc:
+        print(exc, file=sys.stderr)
+        return 1
+
+    print_audit(included, skipped)
+    print("\nLICENCE.txt updated." if changed else "\nLICENCE.txt is already current.")
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

.github/workflows/lint-code-style.yml

@@ -2,6 +2,7 @@ on:
   workflow_dispatch:
   push:
     branches: [ develop, 'release/**' ]
+    paths-ignore: [ LICENCE.txt ]
   #pull_request_target:
   #  branches: [ develop, 'release/**' ]
 

.github/workflows/update-licence.yml

@@ -0,0 +1,53 @@
+on:
+  workflow_dispatch:
+  workflow_run:
+    workflows: [ lint-code-style ]
+    branches: [ develop ]
+    types: [ completed ]
+
+permissions:
+  contents: read
+  pull-requests: read
+
+name: update-licence
+
+concurrency:
+  group: update-licence-develop
+  cancel-in-progress: true
+
+jobs:
+  update-licence:
+    name: update contributors
+    if: >-
+      github.event_name == 'workflow_dispatch' ||
+      github.event.workflow_run.conclusion == 'success'
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out develop
+        uses: actions/checkout@v7
+        with:
+          ref: develop
+          fetch-depth: 0
+          token: ${{ secrets.IKEMEN_TOKEN }}
+
+      - name: Update LICENCE.txt
+        env:
+          GITHUB_TOKEN: ${{ github.token }}
+        run: python3 .github/scripts/update_licence_contributors.py
+
+      - name: Commit LICENCE.txt
+        shell: bash
+        run: |
+          set -euo pipefail
+
+          if git diff --quiet -- LICENCE.txt; then
+            echo "LICENCE.txt is already current."
+            exit 0
+          fi
+
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git add LICENCE.txt
+          git commit -m "docs: update licence contributors"
+          git pull --rebase origin develop
+          git push origin HEAD:develop