Skip to content

Commit 9031541

Browse files
committed
Add howto for publishing
1 parent 7819063 commit 9031541

File tree

4 files changed

+17
-8
lines changed

4 files changed

+17
-8
lines changed

.github/workflows/publish.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,4 @@ jobs:
2222
- run: npm ci
2323
- run: npm run build
2424
- run: npm test
25-
- run: npm publish
25+
- run: npm publish --access public

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Contributing
2+
3+
Anyone is welcome to contribute.
4+
5+
If something has changed that affects the Docs/Demo page, run:
6+
7+
npm run build-docs
8+
9+
## Publishing
10+
11+
To publish a new version to npm, run:
12+
13+
npm version patch # or minor
14+
15+
Push the changes with the new tag to GitHub. A workflow will publish the package.

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -193,11 +193,7 @@ Fires when the user clicks on the Copy Path link of a node.
193193

194194
## Contributing
195195

196-
Anyone is welcome to contribute.
197-
198-
If something has changed that affects the Docs/Demo page, run:
199-
200-
npm run build-docs
196+
Anyone is welcome to contribute. See [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
201197

202198
### Future TODOs
203199

package.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@
1212
"watch-docs": "parcel docs-src/index.html --dist-dir docs/tmp --no-hmr",
1313
"lint": "tslint -c tslint.json -p tsconfig.json",
1414
"test": "jest",
15-
"version-patch": "npm version patch",
16-
"version-minor": "npm version minor",
1715
"precommit": "npm run build-docs && pretty-quick --staged"
1816
},
1917
"keywords": [

0 commit comments

Comments
 (0)