Skip to content

chore: bump version and add CHANGELOG.md #70

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
merged 3 commits into from
Jun 18, 2024
Merged

Conversation

Nemikolh
Copy link
Member

This PR introduces conventional-changelog to update automatically the CHANGELOG.md file based on the git history.

To create a new version in the changelog, one must do:

  1. Update the version field in every package
  2. Run pnpm changelog
  3. Check the update to CHANGELOG.md and add shoutouts for our awesome external contributors 🥳
  4. Open a PR
  5. When the PR is merged and the package is published, update a new tag with:
git tag -a $VERSION $COMMIT_HASH -m "TutorialKit $VERSION"
git push --tags

@Nemikolh Nemikolh requested review from SamVerschueren and d3lm June 12, 2024 15:15
Copy link

Review PR in StackBlitz Codeflow Run & review this pull request in StackBlitz Codeflow.

Copy link

changeset-bot bot commented Jun 12, 2024

⚠️ No Changeset found

Latest commit: 000f128

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.

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
Contributor

@d3lm d3lm left a comment

Choose a reason for hiding this comment

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

Generally I like this but this generates only a single changelog (right?) and it'd be nice to have a changelog for all packages that we publish separately IMO. From this changelog it's not clear which feature or bug belongs to which package (unless I click on something I check myself). That's what I mentioned on Slack where a single changelog could work if we enforced scopes where the scope is the package so it's immediately clear where it belongs to.

@Nemikolh
Copy link
Member Author

@d3lm Ah got it! Makes tons of sense 🙏

The conventional-changelog tool supports providing a --commit-path. With this flag I think we could run it once per package and have it update the changelog for only that package.

Do you think that's worth pursuing?

@d3lm
Copy link
Contributor

d3lm commented Jun 12, 2024

Yea I think that would be cool! Having one changelog for every package we publish is prolly desirable and if we can use --commit-path to do that and run it once per every package that would be cool! Is it possible to include the type of the commit as well? Like feat etc. cause I do like that a lot in the Node.js changelog for instance cause I can quickly ignore some type of commits or look for commits of a specific type which I have done plenty of times for upgrading WebContainer.

@Nemikolh
Copy link
Member Author

Nemikolh commented Jun 12, 2024

Is it possible to include the type of the commit as well?

From my observation, with the angular preset it seems that the tool uses the type to decide where the commit should be positioned in the CHANGELOG.md. So for instance, for feat, the commit ends up in the ## Features section:

## Features

<!-- A commit like "feat: foobar (#123)" seems to land here: -->
* foobar ([#123](<link PR>)) ([<commit hash>](<link commit>))

They seems to have support for other presets and the ability to have our own! 🤯

I can experiement with the presets and let you know what we get for each if you want! 😃

@d3lm
Copy link
Contributor

d3lm commented Jun 14, 2024

I think if it's separated into separate sections then it should be fine 👍 Thanks for checking.

@Nemikolh Nemikolh force-pushed the joan/bump-version branch from a906b24 to 000f128 Compare June 14, 2024 16:27
Copy link
Contributor

@SamVerschueren SamVerschueren left a comment

Choose a reason for hiding this comment

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

Looks great!

@Nemikolh Nemikolh merged commit 9bc112a into main Jun 18, 2024
6 checks passed
@Nemikolh Nemikolh deleted the joan/bump-version branch June 18, 2024 10:09
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