Skip to content

[gh] Updated Changelog Workflow #2632

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.

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
merged 1 commit into from
Feb 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .github/autolabeler-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -67,5 +67,5 @@
"includeGlobs": ["misc/build.func", "misc/install.func", "ct/create_lxc.sh"],
"excludeGlobs": []
}
]
]
}
21 changes: 17 additions & 4 deletions .github/changelog-pr-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,27 @@
"title": "🆕 New Scripts",
"labels": ["new script"]
},
{
"title": "🐞 Bug Fixes",
"labels": ["bugfix"]
},
{
"title": "✨ New Features",
"labels": ["feature"]
},
{
"title": "🚀 Updated Scripts",
"labels": ["update script"],
"subCategories": [
{
"title": "🐞 Bug Fixes",
"labels": ["bugfix"],
"notes" : []
},
{
"title": "General Updates",
"labels": ["general"],
"notes" : []
}
]
},

{
"title": "🌐 Website",
"labels": ["website"]
Expand Down
43 changes: 25 additions & 18 deletions .github/workflows/autolabeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ jobs:
const autolabelerConfig = JSON.parse(fileContent);

const prNumber = context.payload.pull_request.number;
const prBody = context.payload.pull_request.body;
const prBody = context.payload.pull_request.body.toLowerCase();

let labelsToAdd = new Set();

const prListFilesResponse = await github.rest.pulls.listFiles({
Expand All @@ -42,14 +42,35 @@ jobs:
pull_number: prNumber,
});
const prFiles = prListFilesResponse.data;

const templateLabelMappings = {
"🐞 **bug fix**": "bugfix",
"✨ **new feature**": "feature",
"💥 **breaking change**": "breaking change",
"🆕 **new script**": "new script"
};

for (const [checkbox, label] of Object.entries(templateLabelMappings)) {
const escapedCheckbox = checkbox.replace(/([.*+?^=!:${}()|\[\]\/\\])/g, "\\$1");
const regex = new RegExp(`- \\[(x|X)\\]\\s*.*${escapedCheckbox}`, "i");
const match = prBody.match(regex);
if (match) {
console.log(`Match: ${match}`);
labelsToAdd.add(label);
}
}
if (labelsToAdd.size === 0) {
labelsToAdd.add("general");
}

// Apply labels based on file changes
for (const [label, rules] of Object.entries(autolabelerConfig)) {
const shouldAddLabel = prFiles.some((prFile) => {
return rules.some((rule) => {
const isFileStatusMatch = rule.fileStatus ? rule.fileStatus === prFile.status : true;
const isIncludeGlobMatch = rule.includeGlobs.some((glob) => minimatch(prFile.filename, glob));
const isExcludeGlobMatch = rule.excludeGlobs.some((glob) => minimatch(prFile.filename, glob));

return isFileStatusMatch && isIncludeGlobMatch && !isExcludeGlobMatch;
});
});
Expand All @@ -58,21 +79,7 @@ jobs:
labelsToAdd.add(label);
}
}

const templateLabelMappings = {
"🐞 bug fix": "bugfix",
"✨ new feature": "feature",
"💥 breaking change": "breaking change",
"🆕 new script": "new script"
};

for (const [checkbox, label] of Object.entries(templateLabelMappings)) {
const regex = new RegExp(`- \\[x\\] ${checkbox}`, "i"); // Match only checked checkboxes
if (regex.test(prBody)) {
labelsToAdd.add(label);
}
}


console.log(`Labels to add: ${Array.from(labelsToAdd).join(", ")}`);

if (labelsToAdd.size > 0) {
Expand Down
87 changes: 55 additions & 32 deletions .github/workflows/changelog-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ jobs:

- name: Get latest dates in changelog
run: |
# Extrahiere die neuesten zwei Daten aus dem Changelog
DATES=$(grep -E '^## [0-9]{4}-[0-9]{2}-[0-9]{2}' CHANGELOG.md | head -n 2 | awk '{print $2}')

LATEST_DATE=$(echo "$DATES" | sed -n '1p')
Expand All @@ -55,7 +54,15 @@ jobs:
const configPath = path.resolve(process.env.CONFIG_PATH);
const fileContent = await fs.readFile(configPath, 'utf-8');
const changelogConfig = JSON.parse(fileContent);
const categorizedPRs = changelogConfig.map(obj => ({ ...obj, notes: [] }));

const categorizedPRs = changelogConfig.map(obj => ({
...obj,
notes: [],
subCategories: obj.subCategories ?? (obj.labels.includes("update script") ? [
{ title: "🐞 Bug Fixes", labels: ["bugfix"] },
{ title: "✨ Feature Updates", labels: ["feature"] }
] : [])
}));

const latestDateInChangelog = new Date(process.env.LATEST_DATE);
latestDateInChangelog.setUTCHours(23, 59, 59, 999);
Expand All @@ -70,40 +77,36 @@ jobs:
per_page: 100,
});

pulls.filter(pr =>
pr.merged_at &&
new Date(pr.merged_at) > latestDateInChangelog &&
!pr.labels.some(label => ["invalid", "wontdo", process.env.AUTOMATED_PR_LABEL].includes(label.name.toLowerCase()))
pulls.filter(pr =>
pr.merged_at &&
new Date(pr.merged_at) > latestDateInChangelog &&
!pr.labels.some(label =>
["invalid", "wontdo", process.env.AUTOMATED_PR_LABEL].includes(label.name.toLowerCase())
)
).forEach(pr => {

const prLabels = pr.labels.map(label => label.name.toLowerCase());
const prNote = `- ${pr.title} [@${pr.user.login}](https://github.com/${pr.user.login}) ([#${pr.number}](${pr.html_url}))`;

let isCategorized = false;
const updateScriptsCategory = categorizedPRs.find(category =>
category.labels.some(label => prLabels.includes(label))
);

for (const { labels, notes } of categorizedPRs) {
// If no labels are specified (e.g., "Unlabelled"), assign to this category
if (labels.length === 0 && prLabels.length === 0) {
notes.push(prNote);
isCategorized = true;
break;
}
if (updateScriptsCategory) {

const subCategory = updateScriptsCategory.subCategories.find(sub =>
sub.labels.some(label => prLabels.includes(label))
);

// If labels are specified, check if PR has ALL required labels
if (labels.length > 0 && labels.every(label => prLabels.includes(label.toLowerCase()))) {
notes.push(prNote);
isCategorized = true;
break;
}
}

// If PR is not categorized, assign it to the "Unlabelled" category
if (!isCategorized) {
const unlabelledCategory = categorizedPRs.find(cat => cat.title === "❔ Unlabelled");
if (unlabelledCategory) {
unlabelledCategory.notes.push(prNote);
if (subCategory) {
subCategory.notes.push(prNote);
} else {
updateScriptsCategory.notes.push(prNote);
}
}
});

console.log(JSON.stringify(categorizedPRs, null, 2));

return categorizedPRs;

Expand All @@ -119,13 +122,33 @@ jobs:
const changelogPath = path.resolve('CHANGELOG.md');
const categorizedPRs = ${{ steps.get-categorized-prs.outputs.result }};

console.log(JSON.stringify(categorizedPRs, null, 2));

let newReleaseNotes = `## ${today}\n\n### Changes\n\n`;
for (const { title, notes } of categorizedPRs) {
if (notes.length > 0) {
newReleaseNotes += `### ${title}\n\n${notes.join("\n")}\n\n`;
for (const { title, notes, subCategories } of categorizedPRs) {
const hasSubcategories = subCategories && subCategories.length > 0;
const hasMainNotes = notes.length > 0;
const hasSubNotes = hasSubcategories && subCategories.some(sub => sub.notes && sub.notes.length > 0);


if (hasMainNotes || hasSubNotes) {
newReleaseNotes += `### ${title}\n\n`;
}

if (hasMainNotes) {
newReleaseNotes += `${notes.join("\n")}\n\n`;
}

if (hasSubcategories) {
for (const { title: subTitle, notes: subNotes } of subCategories) {
if (subNotes && subNotes.length > 0) {
newReleaseNotes += ` #### ${subTitle}\n\n`;
newReleaseNotes += ` ${subNotes.join("\n ")}\n\n`;
}
}
}
}

}
const changelogContent = await fs.readFile(changelogPath, 'utf-8');
const changelogIncludesTodaysReleaseNotes = changelogContent.includes(`\n## ${today}`);

Expand Down