chore(release): add shipjs (#3017)

* chore(release): add shipjs

* update examples afterPublish

Author: Eunjae Lee

.circleci/config.yml

@@ -118,6 +118,33 @@ jobs:
           name: Build & Test examples
           command: yarn test:examples
 
+  release_if_needed:
+    <<: *defaults
+    steps:
+      - checkout
+      - run: *install_yarn_version
+      - restore_cache: *restore_yarn_cache
+      - run: *run_yarn_install
+      - save_cache: *save_yarn_cache
+      - run:
+          name: Trigger a release if the latest commit is a release commit
+          command: yarn shipjs trigger
+
+  prepare_release:
+    <<: *defaults
+    steps:
+      - checkout
+      - run: *install_yarn_version
+      - restore_cache: *restore_yarn_cache
+      - run: *run_yarn_install
+      - save_cache: *save_yarn_cache
+      - run:
+          name: Prepare a pull request for next release
+          command: |
+            git config --global user.email "[email protected]"
+            git config --global user.name "InstantSearch"
+            yarn run release --yes --no-browse
+
 workflows:
   version: 2
   ci:
@@ -128,3 +155,19 @@ workflows:
       - test_integration
       - test_e2e
       - test_examples
+      - release_if_needed:
+          filters:
+            branches:
+              only:
+                - master
+                - next
+  scheduled_release:
+    triggers:
+      - schedule:
+          cron: '0 9 * * 2'
+          filters:
+            branches:
+              only:
+                - master
+    jobs:
+      - prepare_release

CONTRIBUTING.md

@@ -58,17 +58,21 @@ Files are automatically formatted with Prettier.
 
 ## Release
 
+You need to have `GITHUB_TOKEN` added to your `.env` file. You can create a [personal access token](https://github.com/settings/tokens).
+
 ```sh
 yarn release
 ```
 
+It will create a pull request for the next release. When it's reviewed, approved and merged, then CircleCI will automatically publish it to npm.
+
 ### Beta release
 
 ```sh
-yarn release --beta
+yarn release
 ```
 
-Append `-beta.x` where x is a number to the version for beta, so 4.0.0-beta.2 for example.
+The script will ask you a question about the next version. If it's wrong, you can say "No" and specify the version (e.g. "7.0.0-beta.0"). Then, it will open a pull request for that release. When the pull request is merged, CircleCI will publish it to npm with a `--tag beta` argument.
 
 ## Update docs
 

package.json

@@ -11,7 +11,7 @@
     "start": "yarn storybook",
     "build": "lerna run build --scope react-*",
     "watch": "lerna run watch --scope react-instantsearch-* --parallel",
-    "release": "scripts/release.sh",
+    "release": "shipjs prepare",
     "lint": "eslint --ext .js,.ts,.tsx .",
     "lint:fix": "eslint --ext .js,.ts,.tsx --fix .",
     "type-check": "tsc",
@@ -126,6 +126,7 @@
     "rollup-plugin-node-resolve": "5.2.0",
     "rollup-plugin-replace": "2.2.0",
     "rollup-plugin-uglify": "6.0.3",
+    "shipjs": "0.23.0",
     "style-loader": "1.0.0",
     "typescript": "3.8.3",
     "webpack": "4.40.2",

packages/react-instantsearch-core/package.json

@@ -33,9 +33,7 @@
     "build": "yarn build:cjs && yarn build:es && yarn build:umd",
     "build:cjs": "babel src --root-mode upward --extensions '.js,.ts,.tsx' --out-dir dist/cjs --ignore '**/__tests__/**/*','**/__mocks__/**/*' --quiet",
     "build:es": "BABEL_ENV=es babel src --root-mode upward --extensions '.js,.ts,.tsx' --out-dir dist/es --ignore '**/__tests__/**/*','**/__mocks__/**/*' --quiet",
-    "build:umd": "BABEL_ENV=rollup rollup -c rollup.config.js",
-    "release": "yarn clean && yarn build && yarn publish --non-interactive",
-    "release:beta": "yarn clean && yarn build && yarn publish --tag beta --non-interactive"
+    "build:umd": "BABEL_ENV=rollup rollup -c rollup.config.js"
   },
   "dependencies": {
     "@babel/runtime": "^7.1.2",

packages/react-instantsearch-dom-maps/package.json

@@ -36,9 +36,7 @@
     "build": "yarn build:cjs && yarn build:es && yarn build:umd",
     "build:cjs": "babel src --root-mode upward --extensions '.js,.ts,.tsx' --out-dir dist/cjs --ignore '**/__tests__/**/*','**/__mocks__/**/*' --quiet",
     "build:es": "BABEL_ENV=es babel src --root-mode upward --extensions '.js,.ts,.tsx' --out-dir dist/es --ignore '**/__tests__/**/*','**/__mocks__/**/*' --quiet",
-    "build:umd": "BABEL_ENV=rollup rollup -c rollup.config.js",
-    "release": "yarn clean && yarn build && yarn publish --non-interactive",
-    "release:beta": "yarn clean && yarn build && yarn publish --tag beta --non-interactive"
+    "build:umd": "BABEL_ENV=rollup rollup -c rollup.config.js"
   },
   "dependencies": {
     "@babel/runtime": "^7.1.2",

packages/react-instantsearch-dom/package.json

@@ -35,9 +35,7 @@
     "build": "yarn build:cjs && yarn build:es && yarn build:umd",
     "build:cjs": "babel src --root-mode upward --extensions '.js,.ts,.tsx' --out-dir dist/cjs --ignore '**/__tests__/**/*','**/__mocks__/**/*' --quiet",
     "build:es": "BABEL_ENV=es babel src --root-mode upward --extensions '.js,.ts,.tsx' --out-dir dist/es --ignore '**/__tests__/**/*','**/__mocks__/**/*' --quiet",
-    "build:umd": "BABEL_ENV=rollup rollup -c rollup.config.js",
-    "release": "yarn clean && yarn build && yarn publish --non-interactive",
-    "release:beta": "yarn clean && yarn build && yarn publish --tag beta --non-interactive"
+    "build:umd": "BABEL_ENV=rollup rollup -c rollup.config.js"
   },
   "dependencies": {
     "@babel/runtime": "^7.1.2",

packages/react-instantsearch-native/package.json

@@ -33,9 +33,7 @@
     "watch": "yarn build:cjs --watch",
     "build": "yarn build:cjs && yarn build:es",
     "build:cjs": "babel src --root-mode upward --extensions '.js,.ts,.tsx' --out-dir dist/cjs --ignore '**/__tests__/**/*','**/__mocks__/**/*' --quiet",
-    "build:es": "BABEL_ENV=es babel src --root-mode upward --extensions '.js,.ts,.tsx' --out-dir dist/es --ignore '**/__tests__/**/*','**/__mocks__/**/*' --quiet",
-    "release": "yarn clean && yarn build && yarn publish --non-interactive",
-    "release:beta": "yarn clean && yarn build && yarn publish --tag beta --non-interactive"
+    "build:es": "BABEL_ENV=es babel src --root-mode upward --extensions '.js,.ts,.tsx' --out-dir dist/es --ignore '**/__tests__/**/*','**/__mocks__/**/*' --quiet"
   },
   "dependencies": {
     "@babel/runtime": "^7.1.2",

packages/react-instantsearch/package.json

@@ -31,9 +31,8 @@
     "build:cjs": "babel connectors.js dom.js index.js native.js server.js --root-mode upward --extensions '.js,.ts,.tsx' --out-dir dist --quiet",
     "build:es": "BABEL_ENV=es babel connectors.js dom.js index.js native.js server.js --root-mode upward --extensions '.js,.ts,.tsx' --out-dir dist/es --quiet",
     "build:umd": "BABEL_ENV=rollup rollup -c rollup.config.js",
-    "preparePackageFolder": "mkdir -p dist && cp {package.json,README.md} dist",
-    "release": "yarn clean && yarn preparePackageFolder && yarn build && cd dist && yarn publish --non-interactive",
-    "release:beta": "yarn clean && yarn preparePackageFolder && yarn build && cd dist && yarn publish --tag beta --non-interactive"
+    "preparePackageFolder": "cp package.json dist && cp ../../README.md dist",
+    "prepublishOnly": "yarn run preparePackageFolder"
   },
   "dependencies": {
     "@babel/runtime": "^7.1.2",

scripts/release.sh

@@ -3,6 +3,10 @@ const glob = require('glob');
 const execSync = require('child_process').execSync;
 const [version] = process.argv.slice(2);
 
+execSync('yarn');
+execSync(`yarn upgrade react-instantsearch-dom@${version} -D`);
+execSync(`yarn upgrade react-instantsearch-dom-maps@${version} -D`);
+
 const examplesPath = path.join(__dirname, '..', 'examples');
 
 {
@@ -47,3 +51,7 @@ const examplesPath = path.join(__dirname, '..', 'examples');
     );
   });
 }
+
+const commitMessage = `chore(deps): update examples to react-instantsearch v${version}`;
+execSync('git add examples package.json yarn.lock');
+execSync(`printf "${commitMessage}" | git commit --file -`);