From dd78778911c4440bc5cdb9099c74c874fc9bb82e Mon Sep 17 00:00:00 2001 From: "CanbiZ (MickLesk)" <47820557+MickLesk@users.noreply.github.com> Date: Tue, 17 Nov 2026 16:06:26 +0100 Subject: [PATCH] Credit script authors and list services and website changes in the changelog (#18809) New scripts take their authors from the Author header. Pull requests of services and the website are collected like those of core. Releases mention contributors, are no longer cut at 5000 characters, link the compare view, and are skipped on days without changes. --- .github/changelog-pr-config.json | 36 ++++++ .github/workflows/changelog-pr.yml | 172 +++++++++++++++++---------- .github/workflows/github-release.yml | 28 ++++- 3 files changed, 172 insertions(+), 64 deletions(-) diff --git a/.github/changelog-pr-config.json b/.github/changelog-pr-config.json index fedda7313..1f149c123 100644 --- a/.github/changelog-pr-config.json +++ b/.github/changelog-pr-config.json @@ -203,6 +203,42 @@ } ] }, + { + "title": "πŸ›°οΈ Services", + "labels": [ + "services" + ], + "subCategories": [ + { + "title": "🐞 Bug Fixes", + "labels": [ + "bugfix" + ], + "notes": [] + }, + { + "title": "✨ New Features", + "labels": [ + "feature" + ], + "notes": [] + }, + { + "title": "πŸ’₯ Breaking Changes", + "labels": [ + "breaking change" + ], + "notes": [] + }, + { + "title": "πŸ”§ Refactor", + "labels": [ + "refactor" + ], + "notes": [] + } + ] + }, { "title": "❔ Uncategorized", "labels": [ diff --git a/.github/workflows/changelog-pr.yml b/.github/workflows/changelog-pr.yml index 19a1604c9..7cd7d4d8e 100644 --- a/.github/workflows/changelog-pr.yml +++ b/.github/workflows/changelog-pr.yml @@ -118,9 +118,63 @@ jobs: ) ); + async function getScriptAuthors(pr) { + try { + const { data: files } = await github.rest.pulls.listFiles({ + owner: context.repo.owner, + repo: "ProxmoxVE", + pull_number: pr.number, + per_page: 100, + }); + const ctFile = files.find(file => file.status === "added" && /^ct\/[^/]+\.sh$/.test(file.filename)); + if (!ctFile) return ""; + + const { data: script } = await github.rest.repos.getContent({ + owner: context.repo.owner, + repo: "ProxmoxVE", + path: ctFile.filename, + ref: pr.merge_commit_sha, + }); + const header = Buffer.from(script.content, "base64").toString("utf-8") + .split("\n").slice(0, 20) + .find(line => /^#\s*Authors?:/i.test(line)); + if (!header) return ""; + + // "MickLesk (CanbiZ)" puts the handle first, "SlaviΕ‘a AreΕΎina (tremor021)" in the parentheses + const candidates = header.replace(/^#\s*Authors?:/i, "").split("|").map(part => { + part = part.trim().replace(/^[A-Za-z-]+:\s*/, ""); + const match = part.match(/^([^(]*)\(([^)]*)\)/); + if (!match) return part; + const words = match[1].trim().split(/\s+/).filter(Boolean); + return words.length === 1 ? words[0] : match[2].trim(); + }); + + // A display name used alone in a header; the GitHub account of that name is someone else + const authorAliases = { canbiz: "MickLesk" }; + const logins = []; + for (let candidate of candidates) { + if (!/^[A-Za-z0-9-]+$/.test(candidate)) continue; + candidate = authorAliases[candidate.toLowerCase()] ?? candidate; + try { + const { data: user } = await github.rest.users.getByUsername({ username: candidate }); + if (user.type === "User" && !logins.includes(user.login)) logins.push(user.login); + } catch (error) { + console.log(`No GitHub user ${candidate} (${ctFile.filename}): ${error}`); + } + } + return logins.map(login => `[@${login}](https://github.com/${login})`).join(", "); + } catch (error) { + console.error(`Could not read the author of #${pr.number}: ${error}`); + return ""; + } + } + for (const pr of filteredPRs) { const prLabels = pr.labels.map(label => label.name.toLowerCase()); - if (pr.user.login.includes("push-app-to-main[bot]")) { + const scriptAuthors = prLabels.includes("new script") ? await getScriptAuthors(pr) : ""; + if (scriptAuthors) { + prNote = `- ${pr.title} ${scriptAuthors} ([#${pr.number}](${pr.html_url}))`; + } else if (pr.user.login.includes("push-app-to-main[bot]")) { const scriptName = pr.title; try { @@ -128,11 +182,12 @@ jobs: owner: context.repo.owner, repo: "DevScripts", state: "all", - labels: ["Started Migration To ProxmoxVE"] + labels: ["Started Migration To ProxmoxVE"], + per_page: 100, }); const matchingIssue = relatedIssues.find(issue => - issue.title.toLowerCase().includes(scriptName.toLowerCase()) + issue.title.trim().toLowerCase() === scriptName.trim().toLowerCase() ); if (matchingIssue) { @@ -212,75 +267,70 @@ jobs: } - // ── Engine pull requests ──────────────────────────────────────── - // The engine lives in community-scripts/core, so its changes never - // show up in this repository's PR list -- and a fix there reaches - // every script here. The "πŸ’Ύ Core" category already existed for - // ProxmoxVE PRs labelled `core`; engine PRs land in the same place. - try { - const { data: corePulls } = await github.rest.pulls.list({ - owner: context.repo.owner, - repo: "core", - base: "main", - state: "closed", - sort: "updated", - direction: "desc", - per_page: 100, - }); + // ── Pull requests from other repositories ─────────────────────── + const externalRepos = [ + { repo: "core", category: "πŸ’Ύ Core", prefix: "core" }, + { repo: "services", category: "πŸ›°οΈ Services", prefix: "services" }, + { repo: "ProxmoxVE-Frontend", category: "🌐 Website", prefix: "website" }, + ]; + const externalLabelAliases = { + bug: "bugfix", + bugfix: "bugfix", + enhancement: "feature", + feature: "feature", + refactor: "refactor", + "breaking change": "breaking change", + }; + const externalPriority = ["breaking change", "bugfix", "feature", "refactor"]; - const coreCategory = categorizedPRs.find(category => - category.title.includes("Core") || category.labels.includes("core")); + for (const { repo, category: categoryTitle, prefix } of externalRepos) { + try { + const { data: externalPulls } = await github.rest.pulls.list({ + owner: context.repo.owner, + repo, + base: "main", + state: "closed", + sort: "updated", + direction: "desc", + per_page: 100, + }); - // core carries GitHub's default label set, and most of its pull - // requests carry none at all, so map what maps and let the rest - // sit directly under the category. - const coreLabelAliases = { - bug: "bugfix", - bugfix: "bugfix", - enhancement: "feature", - feature: "feature", - refactor: "refactor", - "breaking change": "breaking change", - }; - const corePriority = ["breaking change", "bugfix", "feature", "refactor"]; + const category = categorizedPRs.find(c => c.title === categoryTitle); - for (const pr of corePulls) { - if (!pr.merged_at) continue; - if (new Date(pr.merged_at) <= latestDateInChangelog) continue; + for (const pr of externalPulls) { + if (!pr.merged_at) continue; + if (new Date(pr.merged_at) <= latestDateInChangelog) continue; - const rawLabels = pr.labels.map(label => label.name.toLowerCase()); - if (rawLabels.some(l => ["invalid", "wontdo", "wontfix", "duplicate", process.env.AUTOMATED_PR_LABEL].includes(l))) continue; + const rawLabels = pr.labels.map(label => label.name.toLowerCase()); + if (rawLabels.some(l => ["invalid", "wontdo", "wontfix", "duplicate", process.env.AUTOMATED_PR_LABEL].includes(l))) continue; - if (!coreCategory) { - console.log(`No Core category configured; skipping core#${pr.number}`); - continue; - } + if (!category) { + console.log(`No ${categoryTitle} category configured; skipping ${prefix}#${pr.number}`); + continue; + } - // core#N rather than #N: a bare number reads as a pull request - // in this repository, so the link would lead somewhere other - // than the text promises. - const coreNote = `- ${pr.title} [@${pr.user.login}](https://github.com/${pr.user.login}) ([core#${pr.number}](${pr.html_url}))`; + // core#N rather than #N: a bare #N links to a pull request in this repository. + const note = `- ${pr.title} [@${pr.user.login}](https://github.com/${pr.user.login}) ([${prefix}#${pr.number}](${pr.html_url}))`; - const mapped = rawLabels.map(l => coreLabelAliases[l]).filter(Boolean); - let placed = false; - if (coreCategory.subCategories && coreCategory.subCategories.length > 0) { - for (const priorityLabel of corePriority) { - if (!mapped.includes(priorityLabel)) continue; - const subCategory = coreCategory.subCategories.find(sub => - sub.labels.includes(priorityLabel)); - if (subCategory) { - subCategory.notes.push(coreNote); - placed = true; - break; + const mapped = rawLabels.map(l => externalLabelAliases[l]).filter(Boolean); + let placed = false; + if (category.subCategories && category.subCategories.length > 0) { + for (const priorityLabel of externalPriority) { + if (!mapped.includes(priorityLabel)) continue; + const subCategory = category.subCategories.find(sub => + sub.labels.includes(priorityLabel)); + if (subCategory) { + subCategory.notes.push(note); + placed = true; + break; + } } } + if (!placed) category.notes.push(note); } - if (!placed) coreCategory.notes.push(coreNote); + } catch (error) { + console.error(`Could not read ${repo} pull requests: ${error}`); } - } catch (error) { - // The engine repository being unreachable must not cost this - // repository its changelog. - console.error(`Could not read core pull requests: ${error}`); } return categorizedPRs; diff --git a/.github/workflows/github-release.yml b/.github/workflows/github-release.yml index ab216bd42..a381e0163 100644 --- a/.github/workflows/github-release.yml +++ b/.github/workflows/github-release.yml @@ -19,6 +19,7 @@ jobs: run: sed -n '/^## /,$p' CHANGELOG.md > changelog_cleaned.md - name: Extract relevant changelog section + id: extract run: | YESTERDAY=$(date -u --date="yesterday" +%Y-%m-%d) echo "Checking for changes on: $YESTERDAY" @@ -26,8 +27,24 @@ jobs: # Extract the section from "## $YESTERDAY" until the next "## YYYY-MM-DD" sed -n "/^## $YESTERDAY/,/^## [0-9]\{4\}-[0-9]\{2\}-[0-9]\{2\}/p" changelog_cleaned.md | head -n -1 > changelog_tmp_full.md - # Truncate the extracted section to 5000 characters - head -c 5000 changelog_tmp_full.md > changelog_tmp.md + # GitHub fills a release's Contributors only from bare @login mentions + sed -i -E 's#\[@([A-Za-z0-9-]+)\]\(https://github\.com/\1\)#@\1#g' changelog_tmp_full.md + + # Keep whole lines up to 120000 characters (GitHub allows 125000) + export LC_ALL=C.UTF-8 + SIZE=0 + TRUNCATED=false + while IFS= read -r line || [ -n "$line" ]; do + SIZE=$((SIZE + ${#line} + 1)) + if [ "$SIZE" -gt 120000 ]; then + TRUNCATED=true + break + fi + printf '%s\n' "$line" + done < changelog_tmp_full.md > changelog_tmp.md + if [ "$TRUNCATED" = true ]; then + printf '\nCut to fit the release size limit. The full list is in [CHANGELOG.md](https://github.com/community-scripts/ProxmoxVE/blob/main/CHANGELOG.md).\n' >> changelog_tmp.md + fi echo "=== Extracted Changelog ===" cat changelog_tmp.md @@ -36,12 +53,17 @@ jobs: # Abort if no content was found if [ ! -s changelog_tmp.md ]; then echo "No changes found for $YESTERDAY, skipping release." - exit 0 + echo "skip=true" >> "$GITHUB_OUTPUT" fi - name: Create GitHub release + if: steps.extract.outputs.skip != 'true' env: GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | YESTERDAY=$(date -u --date="yesterday" +%Y-%m-%d) + PREVIOUS=$(gh release view --json tagName --jq .tagName 2>/dev/null || true) + if [ -n "$PREVIOUS" ]; then + printf '\n**Full Changelog**: https://github.com/community-scripts/ProxmoxVE/compare/%s...%s\n' "$PREVIOUS" "$YESTERDAY" >> changelog_tmp.md + fi gh release create "$YESTERDAY" -t "$YESTERDAY" -F changelog_tmp.md