Skip to content

Commit

Permalink
docs: setup conventional-changelog (#16)
Browse files Browse the repository at this point in the history
Co-authored-by: Max Klenk <[email protected]>
  • Loading branch information
mathiasmoeller and maxklenk authored Jan 11, 2022
1 parent 6528c50 commit c5b676f
Show file tree
Hide file tree
Showing 3 changed files with 386 additions and 20 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,14 +44,18 @@ yarn build

### Publish

In order to update the package, commit all new changes first. Then follow this command to increas the version
In order to update the package, commit all new changes first. Then run the following command:

```bash
yarn version
yarn release
```

This will
* bump the version number according to the types of the last commits (i.e. if it is a major, minor or bug fix release)
* create a new git tag
* update the CHANGELOG.md

Next you need to push both, the code and the new version tag:
```bash
git push
git push --tags
git push && git push --tags
```
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
"use:gitReadme": "mv 'README.md' 'npm.README.md' && mv 'git.README.md' 'README.md'",
"prepublishOnly": "run-s build use:npmReadme && pinst --enable",
"postpublish": "npm run use:gitReadme && pinst --enable",
"prepare": "husky install"
"prepare": "husky install",
"release": "standard-version"
},
"lint-staged": {
"src/**/*.{ts,tsx}": [
Expand Down Expand Up @@ -81,7 +82,8 @@
"ts-loader": "^9.2.5",
"typescript": "^4.4.3",
"webpack": "^5.52.1",
"webpack-cli": "^4.8.0"
"webpack-cli": "^4.8.0",
"standard-version": "^9.3.2"
},
"directories": {
"test": "test"
Expand Down
Loading

0 comments on commit c5b676f

Please sign in to comment.