Skip to content

chore: custom changesets plugin #3694

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 3 commits into
base: main
Choose a base branch
from

Conversation

castastrophe
Copy link
Collaborator

@castastrophe castastrophe commented May 8, 2025

Description

This PR implements a custom changesets changelog plugin for GitHub that improves the changelog generation process. The changes include:

  • Custom changelog plugin: Created @spectrum-tools/changesets-changelog-github plugin to replace the standard @changesets/changelog-github
  • Enhanced formatting: Added emoji prefix (📝) and improved spacing in changelog entries
  • Better commit handling: Simplified commit link generation and improved test coverage
  • Dependency updates: Updated dotenv from ^16.4.7 to ^16.5.0
  • CI integration: Added distinct GitHub token environment variable for plugin's access to user's GitHub username and reading pull request titles.

The plugin provides better control over changelog formatting and ensures consistent output across releases.

How and where has this been tested?

Please tag yourself on the tests you've marked complete to confirm the tests have been run by someone other than the author.

Validation steps

  1. Plugin functionality testing:

    • Run yarn test:plugins to verify the custom changelog plugin works correctly
    • Verify that changelog entries are properly formatted with emoji prefix and correct spacing
    • Test that commit links are generated correctly with shortened commit hashes
  2. Changeset integration testing:

    • Verify that .changeset/config.json correctly references the new custom plugin
    • Test that the plugin generates proper changelog entries for PRs and commits
    • Confirm that the plugin handles multiple authors and various commit formats correctly
  3. CI/CD pipeline testing:

    • Verify that the GitHub workflow includes the necessary environment variable for plugin testing
    • Test that the plugin tests run successfully in the CI environment

Regression testing

Validate:

  1. The documentation pages for at least two other components are still loading, including:
  • The pages render correctly, are accessible, and are responsive.
  1. If components have been modified, VRTs have been run on this branch:
  • VRTs have been run and looked at.
  • Any VRT changes have been accepted (by reviewer and/or PR author), or there are no changes.

To-do list

  • I have read the contribution guidelines.
  • I have updated relevant storybook stories and templates.
  • I have tested these changes in Windows High Contrast mode.
  • If my change impacts other components, I have tested to make sure they don't break.
  • If my change impacts documentation, I have updated the documentation accordingly.
  • ✨ This pull request is ready to merge. ✨

Additional testing completed:

  • Plugin unit tests pass with updated test expectations
  • Changeset configuration properly references the custom plugin
  • Dependency updates are compatible and secure
  • CI workflow includes necessary environment variables for testing

Copy link

changeset-bot bot commented May 8, 2025

⚠️ No Changeset found

Latest commit: c607e65

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@castastrophe castastrophe force-pushed the chore-custom-changesets-changelog-plugin branch 4 times, most recently from c1ec35f to b52053a Compare June 11, 2025 18:10
Copy link
Contributor

github-actions bot commented Jun 11, 2025

File metrics

Summary

Total size: 2.25 MB*

🎉 No changes detected in any packages

* Size is the sum of all main files for packages in the library.
* An ASCII character in UTF-8 is 8 bits or 1 byte.

Copy link
Contributor

github-actions bot commented Jun 11, 2025

🚀 Deployed on https://pr-3694--spectrum-css.netlify.app

@castastrophe castastrophe force-pushed the chore-custom-changesets-changelog-plugin branch 4 times, most recently from 7ef60dd to b79a68e Compare June 11, 2025 18:23
@castastrophe castastrophe force-pushed the chore-custom-changesets-changelog-plugin branch from b79a68e to c607e65 Compare June 19, 2025 20:01
@castastrophe castastrophe marked this pull request as ready for review June 19, 2025 20:07
@castastrophe castastrophe self-assigned this Jun 19, 2025
@castastrophe castastrophe added size-2 S ~6-18hrs; not hard or time consuming, one or two work days to complete. ready-for-review labels Jun 19, 2025
@castastrophe castastrophe force-pushed the chore-custom-changesets-changelog-plugin branch from c607e65 to ba391d9 Compare June 20, 2025 19:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready-for-review size-2 S ~6-18hrs; not hard or time consuming, one or two work days to complete.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant