[Website] Changelog component docs script format enhancements #2953
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.
Important
main
.📌 Summary
If merged, this PR would update the script that generate component changelog entries to a new format, which would support the following enhancements in writing changelog entries.
🛠️ Detailed description
New format
In the new format, changelog component entries must contain comments above and below each component entry that tell the script which portions to use in the appropriate component changelog files.
The path used inside the comments directs the script to what website docs file to attach the entry. That path must match exactly. For example a change to the
LinkStandalone
would use the pathcomponents/links/standalone
.When the script is ran, these comments will be removed following parsing.
Testing
There is a temporary commit included in this PR that allows testing of the script locally. To test this change do the following:
./website
pnpm generate-component-changelog-entries
📸 Screenshots
Changeset file format
Before
After
🔗 External links
Jira ticket: HDS-4951
💬 Please consider using conventional comments when reviewing this PR.
📋 PCI review checklist
Examples of changes to controls include access controls, encryption, logging, etc.
Examples include changes to operating systems, ports, protocols, services, cryptography-related components, PII processing code, etc.