Skip to content

Commit 2cab050

Browse files
committed
chore: add in changesets to handle changelog creation and publishing
1 parent 287a4ca commit 2cab050

File tree

4 files changed

+633
-14
lines changed

4 files changed

+633
-14
lines changed

.changeset/config.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
3+
"changelog": "@changesets/cli/changelog",
4+
"commit": false,
5+
"fixed": [],
6+
"linked": [],
7+
"access": "restricted",
8+
"baseBranch": "master",
9+
"updateInternalDependencies": "patch",
10+
"ignore": []
11+
}

CONTRIBUTING.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
For each change made (anything not marked as a "chore"), run the following command:
2+
```
3+
yarn changeset add
4+
```
5+
6+
This will allow you to do the following:
7+
8+
1) Select impacted packages
9+
2) Add a related message
10+
3) Notify what type of package bump is required (major, minor, patch)
11+
12+
-------
13+
14+
# Releasing
15+
16+
When a maintainer is ready to publish, run the following command to generate a changelog:
17+
18+
```
19+
yarn changeset version
20+
```
21+
22+
You should then verify, using your Git CLI or Git GUI, that the CHANGELOG is correct, everything is up-to-date, and that you're ready to release!
23+
24+
> **Do not create a commit manually after "yarn changeset version"**.
25+
26+
Then, once you've ran `version`, run the following command to publish to NPM:
27+
28+
```
29+
yarn changeset publish
30+
```

package.json

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,9 @@
33
"version": "0.0.0",
44
"private": true,
55
"workspaces": {
6-
"packages": [
7-
"packages/*"
8-
],
6+
"packages": [
7+
"packages/*"
8+
],
99
"nohoist": [
1010
"**/plop-pack-fancy-comments"
1111
]
@@ -45,5 +45,8 @@
4545
},
4646
"lint-staged": {
4747
"*.js": "eslint --cache --fix"
48+
},
49+
"dependencies": {
50+
"@changesets/cli": "^2.22.0"
4851
}
4952
}

0 commit comments

Comments
 (0)