TMC/modded7
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases 5 Wiki Activity

Only Grab URL Cache Once & Fix URL Transforming on GitHub (#717)

Browse Source 
[SKIP]
This commit is contained in:
Integer Limit 2024-04-09 15:04:48 +10:00 committed by GitHub
parent 170464b795
commit daa9508e3b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 29 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
tools/tasks/changelog/createChangelog.ts
View File

@ -9,7 +9,7 @@ import { parsers } from "./definitions";
import parse from "./parser"; import parse from "./parser";
import { specialParserSetup } from "./specialParser"; import { specialParserSetup } from "./specialParser";
import generateModChanges from "./generateModChanges"; import generateModChanges from "./generateModChanges";
import pushAll, { pushChangelog, pushSeperator, pushTitle } from "./pusher"; import pushAll, { pushChangelog, pushSeperator, pushSetup, pushTitle } from "./pusher";
import log from "fancy-log"; import log from "fancy-log";
/** /**
@ -19,6 +19,7 @@ async function createChangelog(): Promise<ChangelogData> {
const data: ChangelogData = new ChangelogData(); const data: ChangelogData = new ChangelogData();
await data.init(); await data.init();
await pushSetup();
// Handle Iterations // Handle Iterations
if (data.shouldIterate()) { if (data.shouldIterate()) {

52
tools/tasks/changelog/pusher.ts
View File

@ -3,17 +3,25 @@ import { categories, defaultIndentation } from "./definitions";
import { Category, ChangelogMessage, Commit } from "../../types/changelogTypes"; import { Category, ChangelogMessage, Commit } from "../../types/changelogTypes";
import { repoLink } from "./definitions"; import { repoLink } from "./definitions";
import { Octokit } from "@octokit/rest"; import { Octokit } from "@octokit/rest";
import { getIssueURL, getNewestIssueURLs, isEnvVariableSet } from "../../util/util"; import { getIssueURL, getNewestIssueURLs } from "../../util/util";
import log from "fancy-log";
let data: ChangelogData; let data: ChangelogData;
let octokit: Octokit | undefined; let octokit: Octokit;
export default async function pushAll(inputData: ChangelogData): Promise<void> { export default async function pushAll(inputData: ChangelogData): Promise<void> {
pushTitle(inputData); pushTitle(inputData);
await pushChangelog(inputData); await pushChangelog(inputData);
} }
export async function pushSetup(): Promise<void> {
octokit = new Octokit({
auth: process.env.GITHUB_TOKEN,
});
// Save Issue/PR Info to Cache
await getNewestIssueURLs(octokit);
}
export function pushTitle(inputData: ChangelogData): void { export function pushTitle(inputData: ChangelogData): void {
data = inputData; data = inputData;
@ -42,16 +50,6 @@ export function pushTitle(inputData: ChangelogData): void {
export async function pushChangelog(inputData: ChangelogData): Promise<void> { export async function pushChangelog(inputData: ChangelogData): Promise<void> {
data = inputData; data = inputData;
if (isEnvVariableSet("GITHUB_TOKEN")) {
octokit = new Octokit({
auth: process.env.GITHUB_TOKEN,
});
}
// Save Issue/PR Info to Cache
if (octokit) await getNewestIssueURLs(octokit);
else log("Skipping Transforming Issue/PR URLs! 'GITHUB_TOKEN' Not Set!");
data.builder.push(`# Changes Since ${data.since}`, ""); data.builder.push(`# Changes Since ${data.since}`, "");
// Push Sections of Changelog // Push Sections of Changelog
@ -123,16 +121,7 @@ async function pushCategory(category: Category) {
hasValues = true; hasValues = true;
} }
} }
const promises: Promise<string>[] = []; await transformAllIssueURLs(categoryLog);
for (let i = 0; i < categoryLog.length; i++) {
const categoryFormatted = categoryLog[i];
// Transform PR and/or Issue tags into a link.
promises.push(
transformTags(categoryFormatted).then((categoryTransformed) => (categoryLog[i] = categoryTransformed)),
);
}
// Apply all Link Changes
await Promise.all(promises);
if (hasValues) { if (hasValues) {
// Push Title // Push Title
data.builder.push(`## ${category.categoryName}:`); data.builder.push(`## ${category.categoryName}:`);
@ -251,12 +240,25 @@ function formatCommit(commit: Commit): string {
return `* [\`${shortSHA}\`](${repoLink}commit/${commit.hash}): ${formattedCommit}`; return `* [\`${shortSHA}\`](${repoLink}commit/${commit.hash}): ${formattedCommit}`;
} }
/**
* Transforms PR/Issue Tags in all strings of the generated changelog.
* @param changelog The list to transform all PR/Issue Tags of.
*/
async function transformAllIssueURLs(changelog: string[]) {
const promises: Promise<string>[] = [];
for (let i = 0; i < changelog.length; i++) {
const categoryFormatted = changelog[i];
// Transform PR and/or Issue tags into a link.
promises.push(transformTags(categoryFormatted).then((categoryTransformed) => (changelog[i] = categoryTransformed)));
}
// Apply all Link Changes
await Promise.all(promises);
}
/** /**
* Transforms PR/Issue Tags into Links. * Transforms PR/Issue Tags into Links.
*/ */
async function transformTags(message: string): Promise<string> { async function transformTags(message: string): Promise<string> {
if (!octokit) return message;
const promises: Promise<string>[] = []; const promises: Promise<string>[] = [];
if (message.search(/#\d+/) !== -1) { if (message.search(/#\d+/) !== -1) {
const matched = message.match(/#\d+/g); const matched = message.match(/#\d+/g);