Merge pull request #26 from satya164/@satya164/release-tooling

Setup some tooling for publishing

Author: osdnk

.gitignore

@@ -46,3 +46,6 @@ bin/
 \.buckd/
 android/app/libs
 android/keystores/debug.keystore
+
+# generated by bob
+lib/

.release-it.json

@@ -0,0 +1,16 @@
+{
+  "increment": "conventional:angular",
+  "scripts": {
+    "changelog": "conventional-changelog -p angular | tail -n +3"
+  },
+  "git": {
+    "commitMessage": "chore: release %s",
+    "tagName": "v%s"
+  },
+  "npm": {
+    "publish": true
+  },
+  "github": {
+    "release": true
+  }
+}

README.md

@@ -56,20 +56,20 @@ class Example extends React.Component {
 
 ## Props
 
-| name                      | required | default | description | 
+| name                      | required | default | description |
 | ------------------------- | -------- | ------- | ------------|
 | snapPoints                | yes      |         | E.g. `[300, 200, 0]`. Points for snapping of bottom sheet coomponent. They define distance from bottom of the screen. Might be number or percent (as string e.g. `'20%'`) for points or percents of screen height from bottom. |
 | initialSnap               | no       |    0    | Determines initial snap point of bottom sheet. The value is the index from snapPoints. |
 | renderContent             | no       |         | Method for rendering scrollable content of bottom sheet. |
 | renderHeader              | no       |         | Method for rendering non-scrollable header of bottom sheet. |
-| enabledGestureInteraction | no       | `true`  | Defines if bottom sheet could be scrollable by gesture. | 
-| enabledManualSnapping     | no       | `true`  | If `false` blocks snapping using `snapTo` method. | 
+| enabledGestureInteraction | no       | `true`  | Defines if bottom sheet could be scrollable by gesture. |
+| enabledManualSnapping     | no       | `true`  | If `false` blocks snapping using `snapTo` method. |
 | enabledInnerScrolling     | no       | `true`  | Defines whether it's possible to scroll inner content of bottom sheet. |
 | callbackNode              | no       |         | `reanimated` node which holds position of bottom sheet, where `0` it the highest snap point and `1` is the lowest. |
 | contentPosition           | no       |         | `reanimated` node which holds position of bottom sheet's content (in dp) |
-| overdragResistanceFactor  | no       |   0     | `Defines how violently sheet has to stopped while overdragging. 0 means no overdrag |  
-| springConfig              | no       | `{ }`   | Overrides config for spring animation | 
-| innerGestureHandlerRefs   | no       |         | Refs for gesture handlers used for building bottom sheet. The array consists fo three refs. The first for PanGH used for inner content scrolling. The second for PanGH used for header. The third for TapGH used for stopping scrolling the content.   | 
+| overdragResistanceFactor  | no       |   0     | `Defines how violently sheet has to stopped while overdragging. 0 means no overdrag |
+| springConfig              | no       | `{ }`   | Overrides config for spring animation |
+| innerGestureHandlerRefs   | no       |         | Refs for gesture handlers used for building bottom sheet. The array consists fo three refs. The first for PanGH used for inner content scrolling. The second for PanGH used for header. The third for TapGH used for stopping scrolling the content.   |
 
 
 ## Methods
@@ -105,3 +105,15 @@ It's not finished and some work has to be done yet.
 2. Horizontal mode
 3. Deal with GH in inner scrollView
 4. Cleanup code (e.g. measuring of components)
+
+## Contributing
+
+### Publishing a release
+
+We use [release-it](https://github.com/release-it/release-it) to automate our release. If you have publish access to the NPM package, run the following from the master branch to publish a new release:
+
+```sh
+yarn release
+```
+
+NOTE: You must have a `GITHUB_TOKEN` environment variable available. You can create a GitHub access token with the "repo" access [here](https://github.com/settings/tokens).

commitlint.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+}

package.json

@@ -2,10 +2,14 @@
   "name": "reanimated-bottom-sheet",
   "version": "1.0.0-alpha.8",
   "description": "Bottom sheet component",
-  "main": "index.js",
+  "main": "lib/commonjs/index.js",
+  "module": "lib/module/index.js",
+  "react-native": "src/index.js",
   "types": "reanimated-bottom-sheet.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "release": "release-it",
+    "prepare": "bob build"
   },
   "keywords": [
     "react-native",
@@ -15,7 +19,8 @@
     "handler"
   ],
   "files": [
-    "index.js",
+    "lib/",
+    "src/",
     "reanimated-bottom-sheet.d.ts",
     "README.md"
   ],
@@ -25,17 +30,35 @@
     "url": "git+https://github.com/osdnk/reanimated-bottom-sheet.git"
   },
   "license": "MIT",
-  "readmeFilename": "README.md",
   "peerDependencies": {
     "react": "*",
     "react-native": "*",
     "react-native-gesture-handler": "*",
     "react-native-reanimated": "*"
   },
   "devDependencies": {
+    "@commitlint/config-conventional": "^7.5.0",
+    "@react-native-community/bob": "^0.3.3",
     "babel-eslint": "^10.0.1",
+    "commitlint": "^7.5.2",
+    "conventional-changelog-cli": "^2.0.12",
     "eslint": "^5.15.1",
     "eslint-plugin-react": "^7.12.4",
-    "react-native-reanimated": "^1.0.0-alpha.12"
+    "husky": "^1.3.1",
+    "react-native-reanimated": "^1.0.0-alpha.12",
+    "release-it": "^10.4.0"
+  },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  },
+  "@react-native-community/bob": {
+    "source": "src",
+    "output": "lib",
+    "targets": [
+      "commonjs",
+      "module"
+    ]
   }
 }