Skip to content

[Website] Changelog component docs script format enhancements #2953

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

dchyun
Copy link
Contributor

@dchyun dchyun commented Jun 16, 2025

Important

⚠️ Wait to merge until all existing PRs with changesets are merged to 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.

  • Support for multi-line changes for one component
  • Remove the requirement that component names in the changelog match exactly to what the script expects

🛠️ 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.

<!-- START components/name -->
`ComponentName` - Change description
<!-- END components/name -->

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 path components/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:

  1. Cd into ./website
  2. Run pnpm generate-component-changelog-entries
  3. Do not commit any changes made

📸 Screenshots

Changeset file format

Before

`ComponentName` - This is a list of changes. Change one. Change two.

After

<!-- START components/name -->
`ComponentName` - This is a list of changes
- Change one
- Change two
<!-- END components/name -->

🔗 External links

Jira ticket: HDS-4951


💬 Please consider using conventional comments when reviewing this PR.

📋 PCI review checklist
  • If applicable, I've documented a plan to revert these changes if they require more than reverting the pull request.
  • If applicable, I've worked with GRC to document the impact of any changes to security controls.
    Examples of changes to controls include access controls, encryption, logging, etc.
  • If applicable, I've worked with GRC to ensure compliance due to a significant change to the in-scope PCI environment.
    Examples include changes to operating systems, ports, protocols, services, cryptography-related components, PII processing code, etc.

Copy link

vercel bot commented Jun 16, 2025

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Updated (UTC)
hds-showcase ✅ Ready (Inspect) Visit Preview Jun 16, 2025 6:01pm
hds-website ✅ Ready (Inspect) Visit Preview Jun 16, 2025 6:01pm

@hashibot-hds hashibot-hds added packages/components docs-website Content updates to the documentation website labels Jun 16, 2025
@@ -6,6 +6,24 @@

### Patch Changes

<!-- START components/card -->
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<!-- START components/card -->
<!-- START components/card -->

[Note] There is a linting error that gets thrown for this format and is only fixed by adding a new line after this comment? Any way to disable this, or another workaround?

@dchyun dchyun marked this pull request as ready for review June 18, 2025 16:07
@dchyun dchyun requested review from a team as code owners June 18, 2025 16:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-website Content updates to the documentation website packages/components
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants