Skip to content

danger: Require attestation that database schema migrations have been applied #58469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maxdeviant merged 4 commits into from
Jun 3, 2026
Merged

danger: Require attestation that database schema migrations have been applied #58469

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
763c276
danger: Require attestation that database schema migrations have been…
maxdeviant Jun 3, 2026
9a6a1ab
Add a change to catch
maxdeviant Jun 3, 2026
d4d88b8
Update wording
maxdeviant Jun 3, 2026
92a3a06
Remove testing change
maxdeviant Jun 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions script/danger/dangerfile.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,6 +61,9 @@ if (includesIssueUrl) {
);
}

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",
Expand All @@ -71,13 +74,24 @@ const modifiedSchemaFiles = danger.git.modified_files.filter((file) =>
);

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"),
);
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.";
Expand Down
Loading