Skip to content

Commit

Permalink
Add auto-release
Browse files Browse the repository at this point in the history
  • Loading branch information
damassi committed Jan 5, 2019
1 parent ffc24d4 commit b71056e
Show file tree
Hide file tree
Showing 4 changed files with 319 additions and 40 deletions.
11 changes: 11 additions & 0 deletions .autorc
@@ -0,0 +1,11 @@
{
"no-version-prefix": true,
"name": "Artsy",
"email": "it@artsymail.com",
"labels": {
"major": "Version: Major",
"minor": "Version: Minor",
"patch": "Version: Patch",
},
"noReleaseLabels": ["Version: Trivial", "Skip Release"]
}
42 changes: 7 additions & 35 deletions README.md
Expand Up @@ -387,51 +387,23 @@ if you have suggestions.
<details>
Circle CI is set up to publish releases to NPM automatically via
[semantic-release][semantic-release] following every successful merge to master.
`react-responsive-media` uses [auto-release](https://github.com/intuit/auto-release#readme) to automatically release on every PR. Every PR should have a label that matches one of the following
Release versions (major, minor, patch) are triggered
[by commit messages][release-commit-message-format], when they adhere to
[Ember conventions][ember-release-format]:
- Version: Trivial
- Version: Patch
- Version: Minor
- Version: Major
```
[TAG context] commit message
```
[Valid tags][release-tags] for release include PATCH, DOC, FIX (patch), FEATURE
(minor), and BREAKING (major). A context is also required. Commits that do not
adhere to this convention will not trigger an NPM release.
##### Example Patch Release
```
[FIX typeface] Add missing unit
[PATCH tooling] Bump version
```
##### Example Minor (Feature) Release
```
[FEATURE ios] Add View primitive
```
##### Example Major (Breaking) Release
```
[BREAKING refactor] Update API to support new platform
```
No release will happen on a `Trivial` update.
</details>
[ci]: https://circleci.com/gh/artsy/react-responsive-media
[ci-icon]: https://circleci.com/gh/artsy/react-responsive-media.svg?style=shield
[npm]: https://www.npmjs.com/package/@artsy/react-responsive-media
[npm-icon]: https://badge.fury.io/js/%40artsy%2Fresponsive.svg
[npm-icon]: https://badge.fury.io/js/%40artsy%2Freact-responsive-media.svg
[react-responsive]: https://github.com/contra/react-responsive
[react-media]: https://github.com/ReactTraining/react-media
[match-media-api]: https://developer.mozilla.org/en-US/docs/Web/API/Window/matchMedia
[new-issue]: https://github.com/artsy/react-responsive-media/issues/new
[semantic-release]: https://github.com/semantic-release/semantic-release
[release-commit-message-format]: https://github.com/semantic-release/semantic-release#commit-message-format
[ember-release-format]: https://github.com/conventional-changelog/conventional-changelog/blob/master/packages/conventional-changelog-ember/readme.md
[release-tags]: https://github.com/artsy/react-responsive-media/blob/master/package.json
6 changes: 4 additions & 2 deletions package.json
Expand Up @@ -10,19 +10,20 @@
"scripts": {
"clean": "rm -rf dist",
"compile": "babel src --out-dir dist -s --source-map --extensions '.ts,.tsx' --ignore src/**/__tests__",
"example": "babel-node --extensions '.js,.jsx,.ts,.tsx' example/server.tsx",
"lint": "tslint -c tslint.json --project tsconfig.json",
"precommit": "lint-staged",
"prepush": "yarn run type-check",
"prepublishOnly": "yarn clean && yarn compile && yarn type-declarations",
"prettier": "prettier",
"prettier-project": "yarn prettier-write 'src/**/*.{ts,tsx}'",
"prettier-write": "yarn prettier --write",
"release": "auto shipit",
"semantic-release": "semantic-release",
"test": "yarn type-check && yarn lint && yarn jest",
"type-check": "tsc --emitDeclarationOnly --pretty",
"type-declarations": "tsc --emitDeclarationOnly",
"watch": "concurrently --raw --kill-others 'yarn compile -w' 'tsc --emitDeclarationOnly -w'",
"example": "babel-node --extensions '.js,.jsx,.ts,.tsx' example/server.tsx"
"watch": "concurrently --raw --kill-others 'yarn compile -w' 'tsc --emitDeclarationOnly -w'"
},
"repository": {
"type": "git",
Expand Down Expand Up @@ -57,6 +58,7 @@
"@types/react-dom": "^16.0.9",
"@types/react-test-renderer": "^16.0.3",
"@types/webpack-dev-server": "^3.1.1",
"auto-release-cli": "^0.37.9",
"babel-core": "^7.0.0-bridge.0",
"babel-jest": "^23.0.1",
"babel-loader": "^8.0.4",
Expand Down

0 comments on commit b71056e

Please sign in to comment.