import { danger, message, warn, fail } from "danger";const { prHygiene } = require("danger-plugin-pr-hygiene"); prHygiene({ prefixPattern: /^([a-z\d\(\)_\s]+):(.*)/g, rules: { // Don't enable this rule just yet, as it can have false positives. useImperativeMood: "off", noConventionalCommits: { bannedTypes: ["feat", "fix", "style", "refactor", "perf", "test", "chore", "build", "revert"], }, },}); const RELEASE_NOTES_PATTERN = /Release Notes:\r?\n\s+-/gm;const body = danger.github.pr.body; const hasReleaseNotes = RELEASE_NOTES_PATTERN.test(body); if (!hasReleaseNotes) { warn( [ "This PR is missing release notes.", "", 'Please add a "Release Notes" section that describes the change:', "", "```", "Release Notes:", "", "- Added/Fixed/Improved ...", "```", "", 'If your change is not user-facing, you can use "N/A" for the entry:', "```", "Release Notes:", "", "- N/A", "```", ].join("\n"), );} const ISSUE_LINK_PATTERN = /(?:- )?(?<!(?:Close[sd]?|Fixe[sd]|Resolve[sd]|Implement[sed]|Follow-up of|Part of):?\s+)https:\/\/github\.com\/[\w-]+\/[\w-]+\/issues\/\d+/gi; const bodyWithoutReleaseNotes = hasReleaseNotes ? body.split(/Release Notes:/)[0] : body;const includesIssueUrl = ISSUE_LINK_PATTERN.test(bodyWithoutReleaseNotes); if (includesIssueUrl) { const matches = bodyWithoutReleaseNotes.match(ISSUE_LINK_PATTERN) ?? []; const issues = matches .map((match) => match.replace(/^#/, "").replace(/https:\/\/github\.com\/zed-industries\/zed\/issues\//, "")) .filter((issue, index, self) => self.indexOf(issue) === index); const issuesToReport = issues.map((issue) => `#${issue}`).join(", "); message( [ `This PR includes links to the following GitHub Issues: ${issuesToReport}`, "If this PR aims to close an issue, please include a `Closes #ISSUE` line at the top of the PR body.", ].join("\n"), );} const MIGRATION_SCHEMA_FILES = [ "crates/collab/migrations/20251208000000_test_schema.sql", "crates/collab/migrations.sqlite/20221109000000_test_schema.sql",]; const modifiedSchemaFiles = danger.git.modified_files.filter((file) => MIGRATION_SCHEMA_FILES.some((schemaFilePath) => file.endsWith(schemaFilePath)),); if (modifiedSchemaFiles.length > 0) { warn( [ "This PR modifies database schema files.", "", "If you are making database changes, a migration needs to be added in the Cloud repository.", ].join("\n"), );} const FIXTURE_CHANGE_ATTESTATION = "Changes to test fixtures are intentional and necessary."; const FIXTURES_PATHS = ["crates/assistant_tools/src/edit_agent/evals/fixtures"]; const modifiedFixtures = danger.git.modified_files.filter((file) => FIXTURES_PATHS.some((fixturePath) => file.includes(fixturePath)),); if (modifiedFixtures.length > 0) { if (!body.includes(FIXTURE_CHANGE_ATTESTATION)) { const modifiedFixturesStr = modifiedFixtures.map((path) => "`" + path + "`").join(", "); fail( [ `This PR modifies eval or test fixtures (${modifiedFixturesStr}), which are typically expected to remain unchanged.`, "If these changes are intentional and required, please add the following attestation to your PR description: ", `"${FIXTURE_CHANGE_ATTESTATION}"`, ].join("\n\n"), ); }}
import { danger, message, warn, fail } from "danger";
const { prHygiene } = require("danger-plugin-pr-hygiene");
prHygiene({
prefixPattern: /^([a-z\d\(\)_\s]+):(.*)/g,
rules: {
// Don't enable this rule just yet, as it can have false positives.
useImperativeMood: "off",
noConventionalCommits: {
bannedTypes: ["feat", "fix", "style", "refactor", "perf", "test", "chore", "build", "revert"],
},
},
});
const RELEASE_NOTES_PATTERN = /Release Notes:\r?\n\s+-/gm;
const body = danger.github.pr.body;
const hasReleaseNotes = RELEASE_NOTES_PATTERN.test(body);
if (!hasReleaseNotes) {
warn(
[
"This PR is missing release notes.",
"",
'Please add a "Release Notes" section that describes the change:',
"",
"```",
"Release Notes:",
"",
"- Added/Fixed/Improved ...",
"```",
"",
'If your change is not user-facing, you can use "N/A" for the entry:',
"```",
"Release Notes:",
"",
"- N/A",
"```",
].join("\n"),
);
}
const ISSUE_LINK_PATTERN =
/(?:- )?(?<!(?:Close[sd]?|Fixe[sd]|Resolve[sd]|Implement[sed]|Follow-up of|Part of):?\s+)https:\/\/github\.com\/[\w-]+\/[\w-]+\/issues\/\d+/gi;
const bodyWithoutReleaseNotes = hasReleaseNotes ? body.split(/Release Notes:/)[0] : body;
const includesIssueUrl = ISSUE_LINK_PATTERN.test(bodyWithoutReleaseNotes);
if (includesIssueUrl) {
const matches = bodyWithoutReleaseNotes.match(ISSUE_LINK_PATTERN) ?? [];
const issues = matches
.map((match) => match.replace(/^#/, "").replace(/https:\/\/github\.com\/zed-industries\/zed\/issues\//, ""))
.filter((issue, index, self) => self.indexOf(issue) === index);
const issuesToReport = issues.map((issue) => `#${issue}`).join(", ");
message(
[
`This PR includes links to the following GitHub Issues: ${issuesToReport}`,
"If this PR aims to close an issue, please include a `Closes #ISSUE` line at the top of the PR body.",
].join("\n"),
);
}
const MIGRATION_SCHEMA_FILES = [
"crates/collab/migrations/20251208000000_test_schema.sql",
"crates/collab/migrations.sqlite/20221109000000_test_schema.sql",
];
const modifiedSchemaFiles = danger.git.modified_files.filter((file) =>
MIGRATION_SCHEMA_FILES.some((schemaFilePath) => file.endsWith(schemaFilePath)),
);
if (modifiedSchemaFiles.length > 0) {
warn(
[
"This PR modifies database schema files.",
"",
"If you are making database changes, a migration needs to be added in the Cloud repository.",
].join("\n"),
);
}
const FIXTURE_CHANGE_ATTESTATION = "Changes to test fixtures are intentional and necessary.";
const FIXTURES_PATHS = ["crates/assistant_tools/src/edit_agent/evals/fixtures"];
const modifiedFixtures = danger.git.modified_files.filter((file) =>
FIXTURES_PATHS.some((fixturePath) => file.includes(fixturePath)),
);
if (modifiedFixtures.length > 0) {
if (!body.includes(FIXTURE_CHANGE_ATTESTATION)) {
const modifiedFixturesStr = modifiedFixtures.map((path) => "`" + path + "`").join(", ");
fail(
[
`This PR modifies eval or test fixtures (${modifiedFixturesStr}), which are typically expected to remain unchanged.`,
"If these changes are intentional and required, please add the following attestation to your PR description: ",
`"${FIXTURE_CHANGE_ATTESTATION}"`,
].join("\n\n"),
);
}
}