chore(release): use semantic-release

Author: imhoffd

.circleci/circle.yml

@@ -0,0 +1,58 @@
+version: 2
+
+aliases:
+  - &restore-cache
+      keys:
+        - dependency-cache-{{ checksum "package.json" }}
+
+  - &save-cache
+      key: dependency-cache-{{ checksum "package.json" }}
+      paths:
+        - node_modules
+
+defaults: &defaults
+  docker:
+    - image: circleci/node:latest
+  working_directory: /tmp/workspace
+
+jobs:
+  build:
+    <<: *defaults
+    steps:
+      - checkout
+      - restore_cache: *restore-cache
+      - run: npm install
+      - save_cache: *save-cache
+      - persist_to_workspace:
+          root: /tmp/workspace
+          paths:
+            - "*"
+
+  deploy:
+    <<: *defaults
+    environment:
+      GIT_AUTHOR_NAME: Ionitron
+      GIT_AUTHOR_EMAIL: [email protected]
+      GIT_COMMITTER_NAME: Ionitron
+      GIT_COMMITTER_EMAIL: [email protected]
+    steps:
+      - add_ssh_keys:
+          fingerprints:
+            - "ae:6d:3a:f1:cf:39:e1:94:6e:22:2a:9f:54:f9:b0:1b" # ionitron user key
+      - checkout
+      - attach_workspace:
+          at: /tmp/workspace
+      - run: echo "//registry.npmjs.org/:_authToken=$NPM_TOKEN" >> ~/.npmrc
+      - run: npm run publish:ci -- --yes
+
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - build
+      - deploy:
+          requires: [build]
+          filters:
+            branches:
+              only: stable

CONTRIBUTING.md

@@ -16,15 +16,17 @@ Please familiarize yourself with [Cordova plugin development](https://cordova.ap
 
 You can use `cordova plugin add` with a local directory to copy and compile plugin changes into a test project.
 
-### Pull Requests
+### Workflow
 
-Please create a pull request for the `master` branch.
+This repo uses [semantic-release](https://github.com/semantic-release/semantic-release), so it's important to follow a strict workflow to ensure properly automated releases.
 
-## Publishing
+* Work off of `master` branch (create new branch or fork)
+* Make changes
+* Use `npm run cz` (or `git cz` if [commitizen](https://github.com/commitizen/cz-cli) is installed globally) to make commits
+* Create a pull request
+    * Pull requests will be approved and squashed into the `master` branch
+    * Try to make pull requests with a single objective (don't have multiple features in one PR, don't mix fixes and features in one PR, etc.)
 
-1. Add changes to `CHANGELOG.md`.
-1. Deploy:
+### Publishing
 
-    ```
-    npm run deploy -- <version>
-    ```
+Releases are automated in CI using [semantic-release](https://github.com/semantic-release/semantic-release) when the `stable` branch is pushed to Github. Rebase `master` with `stable`. Commits in `master` should be appropriately formatted from the PR workflow (see [Workflow](#workflow)).

README.md

@@ -19,6 +19,10 @@
 
 <!-- TODO: remove beta in README.md and CONTRIBUTING.md -->
 
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)
+[![Dependabot Status](https://api.dependabot.com/badges/status?host=github&identifier=104773211)](https://dependabot.com)
+[![npm](https://img.shields.io/npm/v/cordova-plugin-ionic-webview.svg)](https://www.npmjs.com/package/cordova-plugin-ionic-webview)
+
 # Ionic Web View for Cordova
 
 A Web View plugin for Cordova, focused on providing the highest performance experience for Ionic apps (but can be used with any Cordova app).

package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "sync_plugin_xml": "sync-cordova-xml package.json plugin.xml --output=plugin.xml",
     "version": "npm run sync_plugin_xml && git add plugin.xml",
-    "deploy": "np"
+    "cz": "git-cz"
   },
   "repository": {
     "type": "git",
@@ -21,16 +21,51 @@
   ],
   "author": "Ionic Team",
   "license": "Apache-2.0",
-  "devDependencies": {
-    "np": "^3.0.4",
-    "sync-cordova-xml": "^0.4.0"
-  },
   "engines": {
     "cordovaDependencies": {
       "2.0.0": {
         "cordova-android": ">=6.4.0",
         "cordova-ios": ">=4.0.0-dev"
       }
     }
+  },
+  "devDependencies": {
+    "@semantic-release/changelog": "^3.0.0",
+    "@semantic-release/git": "^7.0.4",
+    "@semantic-release/github": "^5.0.6",
+    "@semantic-release/npm": "^5.0.4",
+    "commitizen": "^3.0.2",
+    "cz-conventional-changelog": "^2.1.0",
+    "semantic-release": "^15.9.17",
+    "sync-cordova-xml": "^0.4.0"
+  },
+  "release": {
+    "branch": "stable",
+    "verifyConditions": [
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/github",
+      "@semantic-release/git"
+    ],
+    "prepare": [
+      "@semantic-release/changelog",
+      "@semantic-release/npm",
+      "@semantic-release/git"
+    ],
+    "publish": [
+      "@semantic-release/github",
+      "@semantic-release/npm"
+    ],
+    "success": [
+      "@semantic-release/github"
+    ],
+    "fail": [
+      "@semantic-release/github"
+    ]
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
   }
 }