modded7/tools/tasks/changelog/createChangelog.ts
Integer Limit 542655bcfb
Allow for Multiple Changelogs (#488)
Allows for generating multiple changelogs, useful in further alphas/betas.

[COMBINE]
commits = ["fbd1584e7baed4a3603e3c810066603185f1b230"]
[COMBINE]

[FIXUP]
[[fixes]]
sha = "8fc1c45080f3247f973308aa8824629b98b18a91"
newTitle = "Fix Draconic Evolution Crash (#484)"
newBody = """
[BUG]
[IGNORE]
after = "1.7-alpha-2"
[IGNORE]
"""
[FIXUP]
2023-10-26 20:25:26 +11:00

87 lines
2.4 KiB
TypeScript

import fs from "fs";
import { rootDirectory } from "../../globals";
import upath from "upath";
import marked from "marked";
import buildConfig from "../../buildConfig";
import { categoriesSetup } from "./categoryManagement";
import ChangelogData from "./changelogData";
import { parsers } from "./definitions";
import parse from "./parser";
import { specialParserSetup } from "./specialParser";
import generateModChanges from "./generateModChanges";
import pushAll, { pushChangelog, pushSeperator, pushTitle } from "./pusher";
/**
* Generates a changelog based on environmental variables, and saves it a changelog data class.
*/
async function createChangelog(): Promise<ChangelogData> {
const data: ChangelogData = new ChangelogData();
await data.init();
// Handle Iterations
if (data.shouldIterate()) {
const tags = data.getIterations();
pushTitle(data);
for (const tag of tags) {
data.setupIteration(tag);
categoriesSetup();
specialParserSetup(data);
for (const parser of parsers) {
await parse(data, parser);
}
await generateModChanges(data);
pushChangelog(data);
if (tags.indexOf(tag) < tags.length - 1) {
// More to go
pushSeperator(data);
data.resetForIteration();
}
}
return data;
}
categoriesSetup();
specialParserSetup(data);
for (const parser of parsers) {
await parse(data, parser);
}
await generateModChanges(data);
pushAll(data);
return data;
}
/**
* Creates a changelog based on environment variables, and saves it to the root directory.
*/
export const createRootChangelog = async (): Promise<void> => {
// Make a changelog, and save it.
const builder = (await createChangelog()).builder;
// Write files.
await fs.promises.writeFile(upath.join(rootDirectory, "CHANGELOG.md"), builder.join("\n"));
return fs.promises.writeFile(upath.join(rootDirectory, "CHANGELOG_CF.md"), marked.parse(builder.join("\n")));
};
/**
* Creates a changelog based on environment variables, and saves it to the build directory.
*/
export const createBuildChangelog = async (): Promise<void> => {
// Make a changelog, and save it.
const builder = (await createChangelog()).builder;
// Write files.
await fs.promises.writeFile(upath.join(buildConfig.buildDestinationDirectory, "CHANGELOG.md"), builder.join("\n"));
return fs.promises.writeFile(
upath.join(buildConfig.buildDestinationDirectory, "CHANGELOG_CF.md"),
marked.parse(builder.join("\n")),
);
};