Skip to content
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

Fixes small typos and improves clarity in changesets #82

Merged
merged 2 commits into from
Jan 17, 2024

Conversation

arthurgousset
Copy link
Contributor

@arthurgousset arthurgousset commented Jan 17, 2024

Description

Fixes small typos and improves clarity in changesets created in this PR:

Left comments in #66 a couple of seconds after it was merged. This small PR applies those changes retrospectively.

Tested

No code change

Related issues

Backwards compatibility

No code change

Copy link

changeset-bot bot commented Jan 17, 2024

⚠️ No Changeset found

Latest commit: 8d2c864

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
Member

@aaronmgdr aaronmgdr left a comment

Choose a reason for hiding this comment

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

thank you for this

@arthurgousset
Copy link
Contributor Author

arthurgousset commented Jan 17, 2024

better to make the changes in the changeset files so they are there for the actual release

Originally posted by @aaronmgdr in #66 (comment)

@aaronmgdr: As suggested, I made the changes in the changeset files, rather than in CHANGELOG.md directly.
That means the next time changeset version is run, the updated changeset files should reflect in the changelog.

I didn't re-generate and commit the changelog manually, because when I ran the command I got the following messages:

$ GITHUB_TOKEN=<my-personal-access-token> yarn changeset version
🦋  warn ===============================IMPORTANT!===============================
🦋  warn You are in prerelease mode
🦋  warn If you meant to do a normal release you should revert these changes and run `changeset pre exit`
🦋  warn You can then run `changeset version` again to do a normal release
🦋  warn ----------------------------------------------------------------------
🦋  All files have been updated. Review them and commit at your leisure

No CHANGELOG is generated unless I exit prerelease mode. When I exit prerelease mode, the changelog reflects a "production" release (i.e. not beta).

I was not sure that exiting prerelease mode is appropriate here.
Perhaps best to just commit this and leave CHANGELOG unchanged?
What do you think?

@aaronmgdr
Copy link
Member

@arthurgousset yeah no need to do anything.

@arthurgousset
Copy link
Contributor Author

Sounds good, thanks!

@arthurgousset arthurgousset marked this pull request as ready for review January 17, 2024 13:33
@arthurgousset arthurgousset requested a review from a team as a code owner January 17, 2024 13:33
@arthurgousset arthurgousset enabled auto-merge (squash) January 17, 2024 13:34
@arthurgousset arthurgousset merged commit c99365c into master Jan 17, 2024
16 checks passed
@arthurgousset arthurgousset deleted the 0xarthurxyz/changelog-typos branch January 17, 2024 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants