chore: migrate release process to Ship.js (#1210)

* chore: migrate release process to Ship.js

This commit introduces a new release process by:

- removing the need for the scripts/release.sh bash script in favor of
  https://github.com/algolia/shipjs.
- automating the release in CircleCI

Notable changes are:

- `version` attribute added to the `package.json` file: this is a bit
  redundant with the `version` attribute available in the `lerna.json`
  but it is required by `conventional-changelog-cli`, which is used by Ship.js,
  to generate new Changelog entries, and can only identify versions based
  on the `package.json` file.
- `CHANGELOG.md` text header has been removed because
  `conventional-changelog-ci` is not aware of headers in Changelog
  files.
- `GITHUB_TOKEN` environment variable is now added to the CircleCI
  configuration. It grants CircleCI with the appropriate rights to run
  `shipjs trigger`, effectively publishing to NPM. The value is set to
  the Github account `algolia-api-client-bot` which can be retrieved
  from our Vault cluster, like other credentials.
- `CONTRIBUTING.md` file updated to reflect the updated release process.

* chore: update circleci to run shipjs trigger only on master branch

* chore: remove .npmrc file

* chore: remove unnecessary step in circleci

* chore: remove empty filters

Co-authored-by: eunjae-lee <[email protected]>
Co-authored-by: Eunjae Lee <[email protected]>

Author: 3 people

.circleci/config.yml

@@ -1,9 +1,4 @@
 aliases:
-  - &removes_npmrc
-    name: Removes npmrc
-    command: |
-      rm .npmrc
-
   - &install_yarn_version
     name: Install specific Yarn version
     command: |
@@ -45,7 +40,6 @@ jobs:
     <<: *defaults
     steps:
       - checkout
-      - run: *removes_npmrc
       - run: *install_yarn_version
       - restore_cache: *restore_yarn_cache
       - run: *run_yarn_install
@@ -65,7 +59,6 @@ jobs:
     <<: *defaults
     steps:
       - checkout
-      - run: *removes_npmrc
       - run: *install_yarn_version
       - restore_cache: *restore_yarn_cache
       - run: *run_yarn_install
@@ -79,7 +72,6 @@ jobs:
     <<: *defaults
     steps:
       - checkout
-      - run: *removes_npmrc
       - run: *install_yarn_version
       - restore_cache: *restore_yarn_cache
       - run: *run_yarn_install
@@ -93,7 +85,6 @@ jobs:
     <<: *defaults
     steps:
       - checkout
-      - run: *removes_npmrc
       - run: *install_yarn_version
       - restore_cache: *restore_yarn_cache
       - run: *run_yarn_install
@@ -107,7 +98,6 @@ jobs:
     <<: *defaults
     steps:
       - checkout
-      - run: *removes_npmrc
       - run: *install_yarn_version
       - restore_cache: *restore_yarn_cache
       - run: *run_yarn_install
@@ -119,22 +109,42 @@ jobs:
           name: Browser tests
           command: yarn test:browser-ci
 
+  release:
+    working_directory: ~/algoliasearch-client-javascript
+    description: Perform a new release of the JavaScript client
+    docker:
+      - image: circleci/node:14
+    steps:
+      - checkout
+      - run:
+          command: yarn install
+      - run:
+          command: |
+            if [[ -z "$GITHUB_TOKEN" ]]; then echo '$GITHUB_TOKEN is not set'; exit 1; fi
+            yarn shipjs trigger
+
 workflows:
   version: 2
   ci:
     jobs:
       - test_unit:
           version: '8'
+          name: 'test_unit_8'
       - test_unit:
           version: '10'
+          name: 'test_unit_10'
       - test_unit:
           version: '11'
+          name: 'test_unit_11'
       - test_unit:
           version: '12'
+          name: 'test_unit_12'
       - test_unit:
           version: '13'
+          name: 'test_unit_13'
       - test_unit:
           version: '14'
+          name: 'test_unit_14'
       - test_lint:
           version: '12'
       - test_types:
@@ -143,3 +153,19 @@ workflows:
           version: '12.16.2'
       - test_browser:
           version: '12.16.2'
+      - release:
+          requires:
+            - test_unit_8
+            - test_unit_10
+            - test_unit_11
+            - test_unit_12
+            - test_unit_13
+            - test_unit_14
+            - test_lint
+            - test_types
+            - test_build
+            - test_browser
+          filters:
+            branches:
+              only:
+                - master

.npmrc

@@ -1,11 +1,3 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](http://keepachangelog.com/)
-and this project adheres to [Semantic Versioning](http://semver.org/).
-
-# Release Notes
-
 ## [v4.5.1](https://github.com/algolia/algoliasearch-client-javascript/compare/4.5.0...4.5.1)
 
 ### Fixed

CHANGELOG.md

@@ -90,10 +90,13 @@ TypeScript files are validated using a combination of [Prettier](https://github.
 
 ### Main version
 
-To release a stable version, go on `master` (`git checkout master`) and use:
+To release a stable version, [generate a personal Github token](https://github.com/settings/tokens/new) with the `repo` scope from your logged-in Github account, go on the `master` branch (`git checkout master`) and use:
 
 ```sh
-npm run release
+export GITHUB_TOKEN=XXX # You can add this to your .env or .bashrc/.zshrc configuration file.
+yarn release
 ```
 
-If you're part of the Algolia team, you can read more details [here](https://github.com/algolia/doc-api-clients-squad/blob/master/release/javascript-v4.md)
+This will create a new Github PR proposing a PR to be made. Once merged, the CI will take care of publishing the new version on NPM registry.
+
+If you're part of the Algolia team, you can read more details [here](https://algolia.atlassian.net/wiki/spaces/DX/pages/2034925622/JavaScript+v4+release+process).

CONTRIBUTING.md

@@ -0,0 +1,10 @@
+/* eslint-disable functional/immutable-data */
+/* eslint-disable import/no-commonjs */
+/* eslint-disable max-len */
+
+module.exports = {
+  writerOpts: {
+    headerPartial:
+      '## [v{{version}}](https://github.com/algolia/algoliasearch-client-javascript/compare/{{previousTag}}...{{version}})\n',
+  },
+};

conventional-changelog.config.js

@@ -1,6 +1,7 @@
 {
   "private": true,
   "license": "MIT",
+  "version": "4.5.1",
   "workspaces": [
     "packages/*"
   ],
@@ -10,8 +11,7 @@
     "lint": "eslint . --ext .js,.ts --fix && node ./scripts/sort-package-json.js",
     "playground": "./scripts/prepare-playground.sh && yarn serve",
     "pre-commit": "yarn test:lint && yarn test:types",
-    "release": "./scripts/release.sh",
-    "release-publish": "lerna exec --concurrency 1 -- npm publish --verbose",
+    "release": "shipjs prepare",
     "setup:browser": "yarn node scripts/setup-test-browser.js",
     "test:browser-ci": "yarn setup:browser && ./scripts/prepare-test-browser.sh && wdio ./wdio.saucelabs.conf.js",
     "test:browser-locally": "yarn setup:browser && ./scripts/prepare-test-browser.sh && wdio ./wdio.local.conf.js",
@@ -82,6 +82,7 @@
     "rollup-plugin-terser": "5.2.0",
     "rollup-plugin-typescript2": "0.26.0",
     "serve": "11.3.0",
+    "shipjs": "0.22.0",
     "sort-package-json": "1.40.0",
     "ts-jest": "25.2.1",
     "ts-mockito": "2.5.0",

package.json

@@ -0,0 +1,30 @@
+/* eslint-disable functional/immutable-data */
+/* eslint-disable import/no-commonjs */
+
+const fs = require('fs');
+const path = require('path');
+
+module.exports = {
+  monorepo: {
+    mainVersionFile: 'package.json',
+    packagesToBump: ['packages/*'],
+    packagesToPublish: ['packages/*'],
+  },
+  getTagName: ({ version }) => `${version}`,
+  conventionalChangelogArgs:
+    '--config conventional-changelog.config.js --infile CHANGELOG.md --same-file',
+  versionUpdated({ version, dir }) {
+    // Update version in `lerna.json` file.
+    const lernaConfigPath = path.resolve(dir, 'lerna.json');
+    const lernaConfig = JSON.parse(fs.readFileSync(lernaConfigPath).toString());
+    lernaConfig.version = version;
+    fs.writeFileSync(lernaConfigPath, JSON.stringify(lernaConfig, null, 2));
+
+    // Update version in `packages/client-common/src/version.ts` file since
+    // `shipjs prepare` does not seem to support Typescript version files
+    // bumping (yet?).
+    const clientCommonTypescriptPath = 'packages/client-common/src/version.ts';
+    const clientCommonTypescript = path.resolve(dir, clientCommonTypescriptPath);
+    fs.writeFileSync(clientCommonTypescript, `export const version = '${version}';\n`);
+  },
+};