Max/zkldi_Tachi
1
0
Fork 0
mirror of https://github.com/zkldi/Tachi.git synced 2026-09-22 23:18:05 +03:00
Code Issues Packages Projects Releases Wiki Activity

feat: make the github bot scream at you if you edit .github (#1646)

Browse Source
This commit is contained in:
zk
2026-06-06 21:41:01 +01:00
committed by GitHub
parent 7da34b2c1f
commit ed4bc60a0c
1 changed files with 41 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
typescript/github-bot/src/main.ts
+41 -1
View File
@@ -22,6 +22,7 @@ const app = new App({
const COMMENT_MARKERS = {
questProposal: "<!-- tachi-ghbot:quest-proposal -->",
seedDiff: "<!-- tachi-ghbot:seed-diff -->",
githubDirWarning: "<!-- tachi-ghbot:github-dir-warning -->",
} as const;
type CommentMarker = (typeof COMMENT_MARKERS)[keyof typeof COMMENT_MARKERS];
@@ -86,6 +87,28 @@ function prTouchesSeeds(files: Array<{ filename: string }>): boolean {
return files.some((k) => k.filename.startsWith("db/seeds/") || k.filename === "db/seeds");
}
function prTouchesGithubDir(files: Array<{ filename: string }>): boolean {
return files.some((k) => k.filename.startsWith(".github/") || k.filename === ".github");
}
/**
* Returns the subset of changed files that live inside .github/.
*/
function githubDirFiles(files: Array<{ filename: string }>): Array<string> {
return files.map((k) => k.filename).filter((f) => f.startsWith(".github/") || f === ".github");
}
/**
* Extremely noisy warning comment for PRs that modify files under .github/.
* Changes here can affect CI, permissions, and the entire repository security
* surface, so reviewers must treat them with extreme caution.
*/
function mkGithubDirWarningMsg(touchedFiles: Array<string>): string {
const fileList = touchedFiles.map((f) => `- \`${f}\``).join("\n");
return `${`# ⛔ WARNING ⛔ — This PR modifies files in .github. Don't approve the CI runs until you've read it Mr ZK.\n`.repeat(3)}\n${fileList}`;
}
async function listAllPullFiles(
octokit: {
request: (route: string, params: object) => Promise<{ data: Array<{ filename: string }> }>;
@@ -235,6 +258,20 @@ app.webhooks.on(
pr.number,
);
if (prTouchesGithubDir(filesChanged)) {
const commentAction = await upsertBotComment(
mkGithubDirWarningMsg(githubDirFiles(filesChanged)),
COMMENT_MARKERS.githubDirWarning,
octokit,
repo,
pr.number,
);
log.info(
{ prNumber: pr.number, commentAction },
"Upserted .github dir warning comment.",
);
}
if (prTouchesSeeds(filesChanged)) {
const commentAction = await upsertBotComment(
mkSeedDiffViewMsg(pr.base.sha, pr.head.sha, pr.number),
@@ -247,7 +284,10 @@ app.webhooks.on(
return;
}
log.debug({ prNumber: pr.number }, "PR does not touch db/seeds; no comment posted.");
log.debug(
{ prNumber: pr.number },
"PR does not touch db/seeds or .github; no further comments posted.",
);
} catch (err) {
log.error(
{ err, prNumber: pr.number },