Skip to content

chore: global changelog logic to work before changeset version #5469

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

Merged

Conversation

caseyisonit
Copy link
Contributor

@caseyisonit caseyisonit commented May 12, 2025

Description

This command has to run before changeset version, so we need to manually figure out the correct nextVersion for the changelog and URLs.

Motivation and context

This ensures our changeset will match the correct/same version when changeset version is run in changeset publish

Related issue(s)

Screenshots (if appropriate)

Screenshot 2025-05-12 at 2 01 07 PM Screenshot 2025-05-12 at 2 15 02 PM Screenshot 2025-05-12 at 2 16 25 PM

Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
  • I have added automated tests to cover my changes.
  • I have included a well-written changeset if my change needs to be published.
  • I have included updated documentation if my change required it.

Reviewer's checklist

  • Includes a Github Issue with appropriate flag or Jira ticket number without a link
  • Includes thoughtfully written changeset if changes suggested include patch, minor, or major features
  • Automated tests cover all use cases and follow best practices for writing
  • Validated on all supported browsers
  • All VRTs are approved before the author can update Golden Hash

Manual review test cases

DO NOT COMMIT OR PUSH ANYTHING FROM TESTING

  • Patch version changelog

    1. Pull down this PR
    2. Run yarn prepublishOnly && yarn changelog:global
    3. Review the output to match all available snapshots (patch)
    4. Check the version number is 1.6.1
  • Minor version changelog

    1. Revert the changelog changes from the previous test
    2. Run yarn changeset
    3. Select sp-alert-banner package
    4. Select minor version
    5. Enter changeset message: - **Fixed**: Updated default styles for better contrast [#9999](https://github.com/adobe/spectrum-web-components/pull/9999)
    6. Run yarn changelog:global
    7. Review the output to match all available snapshots (minor and patch)
    8. Check the version number is 1.7.0
  • Major version changelog

    1. Revert the changelog changes from the previous test, not the changeset
    2. Run yarn changeset
    3. Select sp-textfield package
    4. Select major version
    5. Enter changeset message: - **Added**: Added hidden-labelattribute, for use with assistive technologies. (Before:/ After:)
    6. Run yarn changelog:global
    7. Review the output to match all available snapshots (major, minor and patch)
    8. Check the version number is 2.0.0

UNSTAGE ALL CHANGES AND CHANGESETS

@caseyisonit caseyisonit requested a review from a team as a code owner May 12, 2025 20:17
Copy link

changeset-bot bot commented May 12, 2025

⚠️ No Changeset found

Latest commit: beedf63

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

Copy link

Branch preview

Review the following VRT differences

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

Copy link

Tachometer results

Currently, no packages are changed by this PR...

@caseyisonit caseyisonit merged commit f7f75ec into rajdeep/changelog-global May 21, 2025
23 checks passed
@caseyisonit caseyisonit deleted the caseyisonit/global-changelog-fix branch May 21, 2025 16:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants