Skip to content

Commit 9cbc27e

Browse files
committed
ci(changelog): adding semantic-realease changelog as dev-dependency
fix #558
1 parent fb60855 commit 9cbc27e

File tree

3 files changed

+2049
-91
lines changed

3 files changed

+2049
-91
lines changed

contributing.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,14 @@ This doc needs help! Please submit your PR...
44

55
## Commit messages
66

7-
We are using semantic-release to automate the release process, and this depends on a specific format for commit messages. Please run `yarn commit` to use `commitizen` to properly format your commit messages so they can be automatically processed and included in release notes.
7+
We are using semantic-release to automate the release process, and this depends on a specific format for commit messages. Please run `yarn cm` to use `commitizen` to properly format your commit messages so they can be automatically processed and included in release notes.
88

99
## Pull request testing
1010

1111
Some notes on testing and releasing.
12-
* For a PR, follow Github's command-line instructions for retrieving the branch with the changes.
13-
* To start a development server:
12+
13+
- For a PR, follow Github's command-line instructions for retrieving the branch with the changes.
14+
- To start a development server:
1415

1516
```sh
1617
yarn build
@@ -19,21 +20,20 @@ yarn
1920
yarn start
2021
```
2122

22-
* Provide feedback on the PR about your results.
23+
- Provide feedback on the PR about your results.
2324

2425
## Doing a release
2526

2627
We are using semantic-release instead of this:
2728

28-
* update the version number in `package.json`
29+
- update the version number in `package.json`
2930
- Fixes update the patch number, features update the minor number.
3031
- Major version update is reserved for API breaking changes, not just additions.
31-
* `yarn github-changes -- -n 3.X.Y` to update the changelog
32-
* `git add`, `git commit` and `git push` to get the version to master.
33-
* `git tag -a 3.X.Y -m 3.X.Y` `git push --tags`
34-
* `npm publish`
35-
* add a version on the github release page, based on the tag
36-
32+
- `yarn github-changes -- -n 3.X.Y` to update the changelog
33+
- `git add`, `git commit` and `git push` to get the version to master.
34+
- `git tag -a 3.X.Y -m 3.X.Y` `git push --tags`
35+
- `npm publish`
36+
- add a version on the github release page, based on the tag
3737

3838
## Typescript Type Definitions
3939

package.json

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
"start": "npm-run-all clean build:watch",
2121
"gh-pages": "gh-pages -d example",
2222
"github-changes": "github-changes -o wwayne -r react-tooltip -a --only-pulls --use-commit-body",
23-
"commit": "git cz",
23+
"cm": "git cz",
2424
"semantic-release": "semantic-release"
2525
},
2626
"config": {
@@ -43,7 +43,7 @@
4343
"bugs": {
4444
"url": "https://github.com/wwayne/react-tooltip/issues"
4545
},
46-
"homepage": "https://github.com/wwayne/react-tooltip",
46+
"homepage": "https://github.com/wwayne/react-tooltip#readme",
4747
"browserify-shim": {
4848
"react": "global:React",
4949
"react-dom": "global:ReactDOM"
@@ -56,6 +56,16 @@
5656
"prop-types": "^15.7.2",
5757
"uuid": "^7.0.3"
5858
},
59+
"release": {
60+
"plugins": [
61+
"@semantic-release/commit-analyzer",
62+
"@semantic-release/release-notes-generator",
63+
"@semantic-release/changelog",
64+
"@semantic-release/npm",
65+
"@semantic-release/git"
66+
],
67+
"branch": "master"
68+
},
5969
"devDependencies": {
6070
"@babel/cli": "^7.7.4",
6171
"@babel/core": "^7.7.4",
@@ -66,6 +76,11 @@
6676
"@babel/register": "^7.8.3",
6777
"@rollup/plugin-commonjs": "^11.0.2",
6878
"@rollup/plugin-node-resolve": "^7.1.1",
79+
"@semantic-release/changelog": "^5.0.0",
80+
"@semantic-release/commit-analyzer": "^8.0.1",
81+
"@semantic-release/git": "^9.0.0",
82+
"@semantic-release/npm": "^7.0.5",
83+
"@semantic-release/release-notes-generator": "^9.0.1",
6984
"@svgr/rollup": "^4.3.3",
7085
"@testing-library/react": "^9.4.0",
7186
"babel-eslint": "^4.1.1",

0 commit comments

Comments
 (0)