mirror of
https://github.com/zed-industries/zed.git
synced 2024-10-24 07:32:51 +00:00
8ef53aafa2
This PR updates the Danger rules to check for GitHub issue links that aren't in the desired format: <img width="916" alt="Screenshot 2024-07-17 at 5 11 48 PM" src="https://github.com/user-attachments/assets/c77d3c28-3b09-44aa-a97f-03c2400df2e6"> We don't yet check that the links are exactly formatted as expected, just that they aren't incorrectly formatted in the way that people typically get it wrong. Release Notes: - N/A
55 lines
1.5 KiB
TypeScript
55 lines
1.5 KiB
TypeScript
import { danger, warn } from "danger";
|
|
const { prHygiene } = require("danger-plugin-pr-hygiene");
|
|
|
|
prHygiene({
|
|
rules: {
|
|
// Don't enable this rule just yet, as it can have false positives.
|
|
useImperativeMood: "off",
|
|
},
|
|
});
|
|
|
|
const RELEASE_NOTES_PATTERN = new RegExp("Release Notes:\\r?\\n\\s+-", "gm");
|
|
|
|
const hasReleaseNotes = RELEASE_NOTES_PATTERN.test(danger.github.pr.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) ... ([#<public_issue_number_if_exists>](https://github.com/zed-industries/zed/issues/<public_issue_number_if_exists>)).",
|
|
"```",
|
|
"",
|
|
'If your change is not user-facing, you can use "N/A" for the entry:',
|
|
"```",
|
|
"Release Notes:",
|
|
"",
|
|
"- N/A",
|
|
"```",
|
|
].join("\n"),
|
|
);
|
|
}
|
|
|
|
const INCORRECT_ISSUE_LINK_PATTERN = new RegExp("-.*\\(#\\d+\\)", "g");
|
|
|
|
const hasIncorrectIssueLinks = INCORRECT_ISSUE_LINK_PATTERN.test(
|
|
danger.github.pr.body,
|
|
);
|
|
if (hasIncorrectIssueLinks) {
|
|
warn(
|
|
[
|
|
"This PR has incorrectly formatted GitHub issue links in the release notes.",
|
|
"",
|
|
"GitHub issue links must be formatted as plain Markdown links:",
|
|
"",
|
|
"```",
|
|
"- Improved something ([#ISSUE](https://github.com/zed-industries/zed/issues/ISSUE)).",
|
|
"```",
|
|
].join("\n"),
|
|
);
|
|
}
|