Marshall Bowers
7e42c0bb1a
This PR updates the Danger check for touching the Collab schema files to require attestation that the database schema migrations have been created and applied. If there are changes to the schema files without the attestation, Danger will fail the status check with an error: <img width="959" height="635" alt="Screenshot 2026-06-03 at 4 58 56 PM" src="https://github.com/user-attachments/assets/e0857137-b351-4212-a023-13a7d53f5934" /> When the attestation clause is present, Danger will report it as such: <img width="901" height="333" alt="Screenshot 2026-06-03 at 4 59 45 PM" src="https://github.com/user-attachments/assets/098b0ce4-f86e-4d41-b6af-765bc015fe6e" /> Release Notes: - N/A
117 lines
4.0 KiB
TypeScript
117 lines
4.0 KiB
TypeScript
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)+- /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 SCHEMA_CHANGE_ATTESTATION =
|
|
"The corresponding database schema migration has been created in the Cloud repo and applied to the production database.";
|
|
|
|
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) {
|
|
if (body.includes(SCHEMA_CHANGE_ATTESTATION)) {
|
|
message(
|
|
[
|
|
"This PR modifies database schema files.",
|
|
"",
|
|
`The author has attested that ${SCHEMA_CHANGE_ATTESTATION.substring(0, 1).toLowerCase() + SCHEMA_CHANGE_ATTESTATION.substring(1)}`,
|
|
].join("\n"),
|
|
);
|
|
} else {
|
|
const modifiedSchemaFilesStr = modifiedSchemaFiles.map((path) => "`" + path + "`").join(", ");
|
|
fail(
|
|
[
|
|
`This PR modifies database schema files (${modifiedSchemaFilesStr}), which requires creating a schema migration in the Cloud repository.`,
|
|
"Once the schema migraation has been created and applied, please add the following attestation to your PR description: ",
|
|
`"${SCHEMA_CHANGE_ATTESTATION}"`,
|
|
].join("\n\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"),
|
|
);
|
|
}
|
|
}
|