Skip to content

armgit / zed

Public Imported from GitHub
0

Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.

Require release notes to be present (#64238)

Finn Evers93f9fce1152d
diff --git a/script/danger/dangerfile.ts b/script/danger/dangerfile.ts
index 56f9166b995..25ef35a9b9b 100644
--- a/script/danger/dangerfile.ts
+++ b/script/danger/dangerfile.ts
@@ -1,4 +1,4 @@
-import { danger, message, warn, fail, schedule } from "danger";
+import { danger, message, fail, schedule } from "danger";
import { releaseNotesSection, releaseNotesEntries } from "../lib/release-notes";
const { prHygiene } = require("danger-plugin-pr-hygiene");
@@ -16,10 +16,11 @@ prHygiene({
const body = danger.github.pr.body;
const releaseNotes = releaseNotesSection(body);
+const entries = releaseNotesEntries(releaseNotes);
const hasReleaseNotes = releaseNotes !== "";
if (!hasReleaseNotes) {
- warn(
+ fail(
[
"This PR is missing release notes.",
"",
@@ -49,6 +50,19 @@ if (!hasReleaseNotes) {
'If the change is not user-facing for GPUI users, use "- [GPUI] N/A" for that entry.',
].join("\n"),
);
+} else if (
+ entries.some((entry) => {
+ const description = entry.replace(/^-\s*(?:\[GPUI\]\s*)?/i, "").trim();
+ return description === "" || /^(?:N\/A\s+or\s+)?Added\/Fixed\/Improved\s*(?:\.{3}|…)$/i.test(description);
+ })
+) {
+ fail(
+ [
+ "This PR has no proper release notes.",
+ "",
+ 'Please replace them with "N/A" or a description of the changes.',
+ ].join("\n"),
+ );
}
const GPUI_RELEASE_NOTES_PATTERN = /^- \[GPUI\]/im;
@@ -56,7 +70,7 @@ const GPUI_RELEASE_NOTES_PATTERN = /^- \[GPUI\]/im;
const gpuiCrates = danger.git.fileMatch("crates/gpui*/**");
if (gpuiCrates.edited || gpuiCrates.deleted) {
- if (!releaseNotesEntries(releaseNotes).some((entry) => GPUI_RELEASE_NOTES_PATTERN.test(entry))) {
+ if (!entries.some((entry) => GPUI_RELEASE_NOTES_PATTERN.test(entry))) {
const { edited, deleted } = gpuiCrates.getKeyedPaths();
const touchedGpuiCratesStr = [...edited, ...deleted]
.map((file) => "`" + file.split("/")[1] + "`")
diff --git a/script/lib/release-notes.js b/script/lib/release-notes.js
index caf5c75a8a2..9e88ada5243 100644
--- a/script/lib/release-notes.js
+++ b/script/lib/release-notes.js
@@ -14,12 +14,7 @@ function releaseNotesEntries(section) {
break;
}
- entries.push(
- ...paragraph
- .trimEnd()
- .split(/\r?\n(?=- )/)
- .map((entry) => entry.replace(/\r?\n/g, " ")),
- );
+ entries.push(...paragraph.split(/\r?\n(?=- )/).map((entry) => entry.trimEnd().replace(/\r?\n/g, " ")));
}
return entries;
}