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

chore(react): introduce changeset tool for change tracking #607

Merged
merged 1 commit into from
Aug 15, 2024

Conversation

danroberts
Copy link
Contributor

A tool for managing a change log to the library

PR Checklist

  • Important or complicated code is tested
  • Any user facing changes are documented in the Gadget-side changelog
  • Any immediate changes are slated for release in Gadget via a generated package dependency bump
  • Versions within this monorepo are matching and there's a valid upgrade path

Copy link
Contributor

@MillanWangGadget MillanWangGadget left a comment

Choose a reason for hiding this comment

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

Is there a way to make the created filenames based on timestamps? They're currently random word sequences that end up sorted in non-chronological order

CleanShot 2024-08-13 at 15 38 15@2x

Would it also be possible to automatically include the version number in the file contents?
CleanShot 2024-08-13 at 15 39 33@2x

Copy link
Contributor

Choose a reason for hiding this comment

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

Is there are reason why these new Deps are added to the react package and not to the root? I was expecting to do pnpm changeset at the root, but am unable to since all of the changeset stuff is in the react package.

The CLI UI then asks about all of the packages in the repo

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think the reason that the version number isn't in the changeset is because you could have several changesets in the same version. With this tool as I understand it, it will effectively bundle all the individual change files into one changelog, and it will suggest the new version number based on the minor/major changes involved

I don't think we want to track the changelog for all the packages in the repo, just for @gadgetinc/react for now.

Copy link
Contributor

@scott-rc scott-rc left a comment

Choose a reason for hiding this comment

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

LGTM 👍

I've had a good experience using changesets in ggt

"commit": false,
"fixed": [],
"linked": [],
"access": "restricted",
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: If you plan to have changesets release to npm then this will need to be public.

https://github.com/changesets/changesets/blob/main/docs/config-file-options.md#access-restricted--public

@danroberts danroberts merged commit c68909c into main Aug 15, 2024
9 checks passed
@danroberts danroberts deleted the droberts/changeset branch August 15, 2024 14:10
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.

3 participants