feat: add PR description parser for changelog generation #4707
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MounirDhahri
approved these changes
May 6, 2021
| @@ -8,7 +8,7 @@ module.exports = { | |||
| "@images/(.*)": "<rootDir>/images/$1", | |||
| "@relay/(.*)": "<rootDir>/src/lib/relay/$1", | |||
| }, | |||
| testMatch: ["<rootDir>/src/**/__tests__/*tests.(ts|tsx|js)"], | |||
| testMatch: ["<rootDir>/src/**/__tests__/*tests.(ts|tsx|js)", "<rootDir>/scripts/**/*tests.(ts|tsx|js)"], | |||
| } | ||
|
|
||
| fileContents = fileContents.replace(regex, this.generateChangelogSectionTemplate()) | ||
| fileContents = prettier.format(fileContents, { parser: "markdown" }) |
| const ERROR: PRDescriptionParseResult = { type: "error" } | ||
| const NO_CHANGES: PRDescriptionParseResult = { type: "no_changes" } | ||
|
|
||
| describe("parsePRDescription", () => { |
Comment on lines
+5
to
+8
| /** | ||
| * @param {string} description | ||
| * @returns {import('./changelog-types').ParseResult} | ||
| */ |
Comment on lines
+66
to
+98
| function groupItems(lines) { | ||
| /** | ||
| * @type {string[]} | ||
| */ | ||
| const result = [] | ||
|
|
||
| /** | ||
| * @type {string[]} | ||
| */ | ||
| let group = [] | ||
|
|
||
| for (const line of lines) { | ||
| if (line.startsWith("-") || line.startsWith("*")) { | ||
| if (group.length) { | ||
| result.push(group.join("\n")) | ||
| } | ||
| group = [line.slice(1).trim()] | ||
| } else if (line.match(/^\s*$/)) { | ||
| // paragraph | ||
| if (group.length) { | ||
| result.push(group.join("\n")) | ||
| } | ||
| group = [] | ||
| } else { | ||
| group.push(line.trim()) | ||
| } | ||
| } | ||
| if (group.length) { | ||
| result.push(group.join("\n")) | ||
| } | ||
|
|
||
| return result | ||
| } |
brainbicycle
reviewed
May 6, 2021
| "type": "changes", | ||
| } | ||
| `) | ||
| }) |
pvinis
added
the
Squash On Green
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR resolves CX-1211
Description
This creates a parser for PR descriptions, to extract the changelog information that folks will be able to add soon. See the RFC #4499 for more info.
This parser will be used in two places:
I implemented the parser in plain JS with JSDoc-based type annotations, checked by
tsc.Because the parser depends on the exact wording of the PR template header descriptions, I added a function which can be used to update the PR template file. This could then be used on CI to check that the PR template file is in sync with the parser. I'll show this stuff off in Knowledge Share today.
PR Checklist (tick all before merging)