update-workspace-root-version
v1.0.1
Published
Update the workspace root version in a monorepo
Downloads
100
Maintainers
Readme
update-workspace-root-version
Why use it?
Git tags mark a specific point in a repo's history and are usually created at the time of release. Thanks to these tags, we can easily send people links and point to specific code. We can also compare tags to see how files have changed.
Creating tags can be tricky in monorepos, because we can release many packages at once. How do we create just 1 tag (no matter how many packages) and give it a name that resembles a semantic version?
Solution: We let the version of the workspace root indicate the state of the whole project, then set the tag name to be this version. update-workspace-root-version
helps you update the version automatically.
Usage
At the workspace root, install update-workspace-root-version
as a development dependency.
Then, run the codemod before you create a tag. For example, after changesets updates all package versions, we update the workspace root's version.
/* package.json */
{
"scripts": {
"release:changelog": "changeset version; update-workspace-root-version",
},
"devDependencies": {
"@changesets/cli": "...",
"update-workspace-root-version": "..."
}
}
Arguments
# Highest version (default)
update-workspace-root-version --algorithm highest-version
# Increment by one
update-workspace-root-version --algorithm increment-by-one
Limitations
The codemod assumes that every package follows semantic versioning. It is designed to cover typical cases.
Compatibility
- Node.js v18 or above
Contributing
See the Contributing guide for details.
License
This project is licensed under the MIT License.