Skip to content

feat: improve changelog formatting #127

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.

Sign up for GitHub

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
Jun 6, 2025
Merged

feat: improve changelog formatting #127

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
92 changes: 63 additions & 29 deletions changelog/index.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ protected function processPR($repoName, $pr)
{
$title = $this->cleanTitle($pr['title']);
$id = '#' . $pr['number'];
if ($repoName !== 'server') {
if ($repoName !== self::REPO_SERVER) {
$id = $repoName . $id;
}
$data = [
Expand Down Expand Up @@ -163,7 +163,7 @@ protected function getReposToIterate($head = 'master')
// Return repos names
$orgRepositories = array_map(fn($repo): string => $repo['name'], $results);
} catch (\Exception $e) {
throw new Exception('Unable to fetch the github repositories list.');
throw new Exception('Unable to fetch the github repositories list: ' . $e->getMessage());
}

return [...$reposToIterate, ...array_intersect($orgRepositories, $shippedApps)];
Expand Down Expand Up @@ -514,40 +514,48 @@ protected function execute(InputInterface $input, OutputInterface $output)
$output->writeln("");
$output->writeln("<h4>Changes</h4>");
$output->writeln("<ul>");
foreach ($prTitles['closed'] as $id => $data) {
$repoName = $data['repoName'];
$number = $data['number'];
$title = $data['title'];
$output->writeln("\t<li><a href=\"https://github.com/$orgName/$repoName/pull/$number\">$title ($repoName#$number)</a></li>");
$closedPRs = $this->groupPRsByRepo($prTitles['closed']);
foreach ($closedPRs as $repo => $prs) {
$output->writeln("<li><strong><a href=\"https://github.com/$orgName/$repo\">$repo</a></strong><ul>");
foreach ($prs as $id => $data) {
$repoName = $data['repoName'];
$number = $data['number'];
$title = $data['title'];
$output->writeln("\t<li><a href=\"https://github.com/$orgName/$repoName/pull/$number\">$title ($repoName#$number)</a></li>");
}
$output->writeln("</ul></li>");
}
$output->writeln("</ul>");
$count = count($prTitles['pending']);
if ($count > 0) {
$output->writeln("<error>$count pending PRs not printed - maybe the release is not ready yet</error>");
}
break;
case 'forum':
foreach ($prTitles['closed'] as $id => $data) {
$repoName = $data['repoName'];
$number = $data['number'];
$title = $data['title'];
$output->writeln("* [$title ($repoName#$number)](https://github.com/$orgName/$repoName/pull/$number)");
}
$count = count($prTitles['pending']);
if ($count > 0) {
$output->writeln("<error>$count pending PRs not printed - maybe the release is not ready yet</error>");
// Making it a second heading as the first one is the title of the post
$output->writeln("## Nextcloud " . $milestoneToCheck);
$closedPRs = $this->groupPRsByRepo($prTitles['closed']);
foreach ($closedPRs as $repo => $prs) {
$output->writeln("\n### [$repo](https://github.com/$orgName/$repo)");
foreach ($prs as $id => $data) {
$repoName = $data['repoName'];
$number = $data['number'];
$title = $this->escapeMarkdown($data['title']);
$output->writeln("* [$title ($repoName#$number)](https://github.com/$orgName/$repoName/pull/$number)");
}
}
break;
case 'markdown':
default:
foreach ($prTitles['closed'] as $id => $data) {
$repoName = $data['repoName'];
$number = $data['number'];
$title = $data['title'];
if ($repoName === 'server') {
$output->writeln("* #$number");
} else {
$output->writeln("* $orgName/$repoName#$number");
$output->writeln("## Nextcloud " . $milestoneToCheck);
$closedPRs = $this->groupPRsByRepo($prTitles['closed']);
foreach ($closedPRs as $repo => $prs) {
$output->writeln("\n### [$repo](https://github.com/$orgName/$repo)");
foreach ($prs as $id => $data) {
$repoName = $data['repoName'];
$number = $data['number'];
$title = $data['title'];
if ($repoName === self::REPO_SERVER) {
$output->writeln("* #$number");
} else {
$output->writeln("* $orgName/$repoName#$number");
}
}
}

Expand Down Expand Up @@ -592,7 +600,7 @@ function ($a, $b) {
$output->writeln("* $author");
$prevAuthor = $author;
}
if ($repoName === 'server') {
if ($repoName === self::REPO_SERVER) {
$output->writeln(" * [ ] #$number");
} else {
$output->writeln(" * [ ] $orgName/$repoName#$number");
Expand All @@ -606,6 +614,32 @@ function ($a, $b) {
# TODO
#$client->removeCache();
}

function escapeMarkdown(string $text): string {
// Escape characters that break markdown
$escapeChars = ['*', '_', '~', '`', '[', ']', '(', ')', '#', '+', '-', '!', '|'];
foreach ($escapeChars as $char) {
$text = str_replace($char, '\\' . $char, $text);
}
return $text;
}

function groupPRsByRepo($prs) {
$grouped = [];
foreach ($prs as $pr) {
Copy link
Collaborator

@Altahrim Altahrim Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we sort $prs by title here to have all commits on the same type together (fix, feat…)?

Copy link
Member Author

@skjnldsv skjnldsv Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would be nice yeah!
And maybe remove chores and ci commits? :)

$repo = $pr['repoName'];
$grouped[$repo][] = $pr;
}
ksort($grouped);

// Put server on top
if (isset($grouped[self::REPO_SERVER])) {
$serverPRs = $grouped[self::REPO_SERVER];
unset($grouped[self::REPO_SERVER]);
$grouped = array_merge([self::REPO_SERVER => $serverPRs], $grouped);
}
return $grouped;
}
}

$application = new Application();
Expand Down