vrr/zed
2
0
Fork 0
mirror of https://github.com/zed-industries/zed.git synced 2026-07-10 00:13:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 18

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

Browse source 
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
This commit is contained in:
Marshall Bowers 2026-06-03 17:19:31 -04:00 • committed by GitHub
parent 21212496b5
commit 7e42c0bb1a
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 21 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

28
script/danger/dangerfile.ts
View file

@ -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",
@ -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.";