Skip to content

Commit ac1927b

Browse files
authored
Correct setup instructions for a monorepo w/ independent versions (#87)
The setup instructions for a monorepo with independently released versions mentions that the version of the root package needs to be formatted a certain way. This was true when we were first developing this tool, but we have changed this requirement since.
1 parent 47d2937 commit ac1927b

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

docs/setup.md

+2-5
Original file line numberDiff line numberDiff line change
@@ -33,17 +33,14 @@ Combined with the changes above, this might look like:
3333

3434
### Monorepos with independent versions
3535

36-
For a monorepo with independent versions, you will want to:
37-
38-
1. Add a `release.config.json` with a `versioningStrategy` of `"independent"`.
39-
2. Change the format of the `version` within the root `package.json` from `<major>.<minor>.<patch>` to `<yyyymmdd>.1.0` (where `yyyymmdd` is a date in ISO format without the dashes, and `1` is the build number, which will be incremented with successive releases).
36+
For a monorepo with independent versions, you will want to add a `release.config.json` with a `versioningStrategy` of `"independent"`.
4037

4138
Combined with the changes above, this might look like:
4239

4340
```
4441
# package.json
4542
{
46-
"version": "20220607.1.0",
43+
"version": "1.0.0",
4744
"workspaces": ["packages/*"],
4845
}
4946

0 commit comments

Comments
 (0)