chore: introduce changesets #9502
Conversation
|
View your CI Pipeline Execution ↗ for commit ab7eb13
☁️ Nx Cloud last updated this comment at |
|
Sizes for commit ab7eb13:
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #9502 +/- ##
=======================================
Coverage ? 45.30%
=======================================
Files ? 208
Lines ? 8283
Branches ? 1869
=======================================
Hits ? 3753
Misses ? 4085
Partials ? 445 🚀 New features to boost your workflow:
|
| workflow_dispatch: | ||
| inputs: | ||
| tag: | ||
| description: override release tag | ||
| required: false |
There was a problem hiding this comment.
I think we need this to trigger manual releases from the github actions workflow
There was a problem hiding this comment.
or rather, we “needed” this. how can I force publish a release with changesets only?
There was a problem hiding this comment.
Yes you can do this with changesets alone!
| @@ -237,7 +167,7 @@ Use an appropriate commit type. Be especially careful with breaking changes. | |||
|
|
|||
| ## Releases | |||
|
|
|||
| For each new commit added to `main` with `git push` or by merging a pull request or merging from another branch, a GitHub action is triggered and runs the `semantic-release` command to make a release if there are codebase changes since the last release that affect the package functionalities. | |||
| For each new commit added to `main`, a GitHub Workflow is triggered which runs the [Changesets Action](https://github.com/changesets/action). This generates a preview PR showing the impact of all changesets. When this PR is merged, the package will be published to NPM. | |||
There was a problem hiding this comment.
this sounds like more work for maintainers. Previously, I just merged a PR with fix: or feat: prefix in the commit message (which I could alter while squash merging if someone didn’t do that correctly) and it would auto-trigger a release. Now I have to:
- generate a changeset or remind people to do that
- wait for the preview PR to show up
- merge that, too
There was a problem hiding this comment.
Hey @TkDodo , yes it's definitely an extra step, maybe this wasn't explicitly addressed in that Discord thread. I'll still advocate for this change as I believe the downsides are outweighed by the benefits, but happy to discuss further on Discord!
| ## Commit message conventions | ||
| ## Changesets | ||
|
|
||
| `TanStack/query` is using [Angular Commit Message Conventions](https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines). | ||
|
|
||
| We have very precise rules over how our git commit messages can be formatted. This leads to **more readable messages** that are easy to follow when looking through the **project history**. | ||
|
|
||
| ### Commit Message Format | ||
|
|
||
| Each commit message consists of a **header**, a **body** and a **footer**. The header has a special | ||
| format that includes a **type**, a **scope** and a **subject**: | ||
|
|
||
| ```text | ||
| <type>(<scope>): <subject> | ||
| <BLANK LINE> | ||
| <body> | ||
| <BLANK LINE> | ||
| <footer> | ||
| ``` | ||
|
|
||
| The **header** is mandatory and the **scope** of the header is optional. | ||
|
|
||
| Any line of the commit message cannot be longer than 100 characters! This allows the message to be easier to read on GitHub as well as in various git tools. | ||
|
|
||
| ### Type | ||
|
|
||
| Must be one of the following: | ||
|
|
||
| - **feat**: A new feature | ||
| - **fix**: A bug fix | ||
| - **docs**: Documentation only changes | ||
| - **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semicolons, etc.) | ||
| - **refactor**: A code change that neither fixes a bug nor adds a feature | ||
| - **perf**: A code change that improves performance | ||
| - **test**: Adding missing or correcting existing tests | ||
| - **chore**: Changes to the build process or auxiliary tools and libraries such as documentation generation | ||
|
|
||
| ### Scope | ||
|
|
||
| The scope could be anything specifying place of the commit change. For example `query-core`, `react-query` etc... | ||
|
|
||
| You can use `*` when the change affects more than a single scope. | ||
|
|
||
| ### Subject | ||
|
|
||
| The subject contains succinct description of the change: | ||
|
|
||
| - use the imperative, present tense: "change" not "changed" nor "changes" | ||
| - don't capitalize first letter | ||
| - no dot (.) at the end | ||
|
|
||
| ### Body | ||
|
|
||
| Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes". The body should include the motivation for the change and contrast this with previous behavior. | ||
|
|
||
| ### Footer | ||
|
|
||
| The footer should contain any information about **Breaking Changes** and is also the place to [reference GitHub issues that this commit closes](https://help.github.com/en/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue). | ||
|
|
||
| **Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this. | ||
|
|
||
| ### Example | ||
|
|
||
| Here is an example of the release type that will be done based on a commit messages: | ||
|
|
||
| | Commit message | Release type | | ||
| | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | | ||
| | fix(pencil): stop graphite breaking when too much pressure applied | Patch Release | | ||
| | feat(pencil): add `graphiteWidth` option | ~~Minor~~ Feature Release | | ||
| | perf(pencil): remove `graphiteWidth` option<br/><br/>BREAKING CHANGE: The `graphiteWidth` option has been removed.<br/>The default graphite width of 10mm is always used for performance reasons. | ~~Major~~ Breaking Release | | ||
|
|
||
| ### Revert | ||
|
|
||
| If the commit reverts a previous commit, it should begin with `revert:`, followed by the header of the reverted commit. In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted. |
There was a problem hiding this comment.
Hello,
I noticed that the commit message conventions section in the CONTRIBUTING.md appears to be removed in this update, so I wanted to check.
Could you please share if there is any particular reason or background for removing this section?
Since it seems to be an important part of maintaining the team’s commit message conventions, I’d like to better understand.
Thank you!
There was a problem hiding this comment.
Hey @sukvvon , the commit messages are currently more important because they directly influence versioning logic. With changesets, the commit messages no longer affect versioning. I'm happy to keep in a section about writing good commit messages, but I don't think it needs to be as extensive!
There was a problem hiding this comment.
Hey @sukvvon , the commit messages are currently more important because they directly influence versioning logic. With changesets, the commit messages no longer affect versioning. I'm happy to keep in a section about writing good commit messages, but I don't think it needs to be as extensive!
https://github.com/pmndrs/zustand/blob/main/CONTRIBUTING.md#committing
How about referring to the link above? It’s a brief version I wrote before, and I think it can meet our needs!
As discussed on Discord (private channel): https://discord.com/channels/719702312431386674/1345158793675276319
See also: TanStack/config#218 and TanStack/virtual#946