Skip to content

Commit

Permalink
ci(changelog): adding semantic-realease changelog as dev-dependency
Browse files Browse the repository at this point in the history
  • Loading branch information
roggervalf committed Apr 18, 2020
1 parent fb60855 commit 9cbc27e
Show file tree
Hide file tree
Showing 3 changed files with 2,049 additions and 91 deletions.
22 changes: 11 additions & 11 deletions contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@ This doc needs help! Please submit your PR...

## Commit messages

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.
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.

## Pull request testing

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

- For a PR, follow Github's command-line instructions for retrieving the branch with the changes.
- To start a development server:

```sh
yarn build
Expand All @@ -19,21 +20,20 @@ yarn
yarn start
```

* Provide feedback on the PR about your results.
- Provide feedback on the PR about your results.

## Doing a release

We are using semantic-release instead of this:

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

- `yarn github-changes -- -n 3.X.Y` to update the changelog
- `git add`, `git commit` and `git push` to get the version to master.
- `git tag -a 3.X.Y -m 3.X.Y` `git push --tags`
- `npm publish`
- add a version on the github release page, based on the tag

## Typescript Type Definitions

Expand Down
19 changes: 17 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
"start": "npm-run-all clean build:watch",
"gh-pages": "gh-pages -d example",
"github-changes": "github-changes -o wwayne -r react-tooltip -a --only-pulls --use-commit-body",
"commit": "git cz",
"cm": "git cz",
"semantic-release": "semantic-release"
},
"config": {
Expand All @@ -43,7 +43,7 @@
"bugs": {
"url": "https://github.com/wwayne/react-tooltip/issues"
},
"homepage": "https://github.com/wwayne/react-tooltip",
"homepage": "https://github.com/wwayne/react-tooltip#readme",
"browserify-shim": {
"react": "global:React",
"react-dom": "global:ReactDOM"
Expand All @@ -56,6 +56,16 @@
"prop-types": "^15.7.2",
"uuid": "^7.0.3"
},
"release": {
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"@semantic-release/changelog",
"@semantic-release/npm",
"@semantic-release/git"
],
"branch": "master"
},
"devDependencies": {
"@babel/cli": "^7.7.4",
"@babel/core": "^7.7.4",
Expand All @@ -66,6 +76,11 @@
"@babel/register": "^7.8.3",
"@rollup/plugin-commonjs": "^11.0.2",
"@rollup/plugin-node-resolve": "^7.1.1",
"@semantic-release/changelog": "^5.0.0",
"@semantic-release/commit-analyzer": "^8.0.1",
"@semantic-release/git": "^9.0.0",
"@semantic-release/npm": "^7.0.5",
"@semantic-release/release-notes-generator": "^9.0.1",
"@svgr/rollup": "^4.3.3",
"@testing-library/react": "^9.4.0",
"babel-eslint": "^4.1.1",
Expand Down

0 comments on commit 9cbc27e

Please sign in to comment.