refactor(generate:changeset): Condense front matter into single section #24251
Conversation
This file contains hidden or 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
github-actions
bot
added
base: main
There was a problem hiding this comment.
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (3)
build-tools/packages/build-cli/src/library/changesets.ts:250
- [nitpick] Consider defining a constant for the custom prefix '__' to improve maintainability and avoid hardcoding.
if (key.startsWith("__")) {
build-tools/packages/build-cli/src/commands/generate/changeset.ts:432
- [nitpick] Review the removal of extra front matter separators to ensure that the resulting format is consistently parsed downstream; a brief explanatory comment might improve clarity for future maintainers.
if (additionalMetadata !== undefined) {
build-tools/packages/build-cli/src/commands/generate/changelog.ts:118
- Verify that filtering out keys with the '__' prefix reliably excludes all Fluid-specific metadata, ensuring that changelog outputs only include package version bump information.
.filter(([key]) => !key.startsWith("__"))
alexvy86
approved these changes
Apr 4, 2025
| const packageBumpTypeMetadata = firstParse.data; | ||
|
|
||
| // If there is a second frontmatter section, parse it as the additional metadata. | ||
| const hasAdditionalMetadata = hasFrontMatter(firstParse.content); |
There was a problem hiding this comment.
This seems to have been the only use of hasFrontMatter... build-tools doesn't complain about unused imports?
There was a problem hiding this comment.
Yeah, looks like the tsconfig option is disabled but the lint rule is not enabled. I'll follow up with another change to enable the lint rule and fix violations.
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.
Our custom changeset metadata is in its own separate front-matter section. However, most tools do not recognize more than one front-matter section, so this has not been an ideal solution when we want to use other tools on our changesets (e.g. review tools, formatters, linting tools, etc.).
This change condenses the fron matter into a single section, using
__to prefix fluid-specific properties.We already have to remove custom metadata when producing changelogs so that process has just been updated to remove the custom properties rather than the second front matter section.
The motivator for this change is to make it easier to use markdown-aware tools with our changesets. See #24252 for an example.