ci: set up release script

Author: ulivz

package.json

@@ -11,8 +11,8 @@
     "dev": "lerna exec --scope docs -- yarn dev",
     "build": "lerna exec --scope docs -- yarn build",
     "lint": "eslint --fix packages/**/*.js packages/**/*.vue packages/**/bin/*",
-    "prepublishOnly": "conventional-changelog -p angular -r 2 -i CHANGELOG.md -s",
-    "release": "/bin/bash scripts/release.sh",
+    "release": "yarn --pure-lockfile && node scripts/release.js",
+    "changelog": "node scripts/genChangelog.js run",
     "test": "node scripts/test.js"
   },
   "repository": {
@@ -47,7 +47,9 @@
     "lerna": "^2.11.0",
     "lint-staged": "^7.0.4",
     "minimist": "^1.2.0",
-    "yorkie": "^1.0.3"
+    "yorkie": "^1.0.3",
+    "inquirer": "^6.2.0",
+    "@vue/conventional-changelog": "^0.1.1"
   },
   "engines": {
     "node": ">=8"

scripts/genChangelog.js

@@ -0,0 +1,27 @@
+const execa = require('execa')
+const cc = require('conventional-changelog')
+const config = require('@vue/conventional-changelog')
+
+const gen = module.exports = version => {
+  const fileStream = require('fs').createWriteStream(`CHANGELOG.md`)
+
+  cc({
+    config,
+    releaseCount: 0,
+    pkg: {
+      transform (pkg) {
+        pkg.version = `v${version}`
+        return pkg
+      }
+    }
+  }).pipe(fileStream).on('close', async () => {
+    delete process.env.PREFIX
+    await execa('git', ['add', '-A'], { stdio: 'inherit' })
+    await execa('git', ['commit', '-m', `chore: ${version} changelog`], { stdio: 'inherit' })
+  })
+}
+
+if (process.argv[2] === 'run') {
+  const version = require('../lerna.json').version
+  gen(version)
+}

scripts/release.js

@@ -0,0 +1,104 @@
+/**
+
+ How to do a release:
+
+ 1. Make sure you have publish access for all packages:
+ - You must be in the VuePress team in the npm @vuepress organization
+ - Make sure you DO NOT have npm per-publish 2-factor / OTP enabled, as it
+ does not work with Lerna (which we use for batch publishing).
+
+ 2. Run `yarn release`, follow prompts
+
+ 3A. If everything works properly, the tag should have been auto-pushed and a
+ local changelog commit should have been generated. Go to 4.
+
+ 3B. If the publish fails half-way, things have gotten hairy. Now you need to
+ go to npm to check which packages have been published and manually publish
+ the ones that have not been published yet. After all have been published:
+
+ 3B.1. Push the release git tag to GitHub.
+ 3B.2. Run `yarn changelog` to generate changelog commit.
+
+ 4. Push the changelog commit to `next` branch.
+
+ 5. Go to GitHub and verify that the changelog is live.
+
+ 6. Go to GitHub releases page and publish the release.
+
+ */
+
+process.env.VUE_CLI_RELEASE = true
+
+const execa = require('execa')
+const semver = require('semver')
+const inquirer = require('inquirer')
+
+const curVersion = require('../lerna.json').version
+
+const release = async () => {
+  console.log(`Current version: ${curVersion}`)
+
+  const bumps = ['patch', 'minor', 'major', 'prerelease', 'premajor']
+  const versions = {}
+  bumps.forEach(b => {
+    versions[b] = semver.inc(curVersion, b)
+  })
+  const bumpChoices = bumps.map(b => ({ name: `${b} (${versions[b]})`, value: b }))
+
+  const { bump, customVersion } = await inquirer.prompt([
+    {
+      name: 'bump',
+      message: 'Select release type:',
+      type: 'list',
+      choices: [
+        ...bumpChoices,
+        { name: 'custom', value: 'custom' }
+      ]
+    },
+    {
+      name: 'customVersion',
+      message: 'Input version:',
+      type: 'input',
+      when: answers => answers.bump === 'custom'
+    }
+  ])
+
+  const version = customVersion || versions[bump]
+
+  const { yes } = await inquirer.prompt([{
+    name: 'yes',
+    message: `Confirm releasing ${version}?`,
+    type: 'list',
+    choices: ['N', 'Y']
+  }])
+
+  if (yes === 'N') {
+    console.log('[release] cancelled.')
+    return
+  }
+
+  const releaseArguments = [
+    'publish',
+    '--repo-version',
+    version,
+    '--force-publish',
+    '*'
+  ]
+
+  console.log(`lerna ${releaseArguments.join(' ')}`)
+
+  await execa(require.resolve('lerna/bin/lerna'), [
+    'publish',
+    '--repo-version',
+    version,
+    '--force-publish',
+    '*'
+  ], { stdio: 'inherit' })
+
+  require('./genChangelog')(version)
+}
+
+release().catch(err => {
+  console.error(err)
+  process.exit(1)
+})

scripts/release.sh

@@ -1305,6 +1305,14 @@
     source-map "^0.5.6"
     vue-template-es2015-compiler "^1.6.0"
 
+"@vue/conventional-changelog@^0.1.1":
+  version "0.1.1"
+  resolved "https://registry.yarnpkg.com/@vue/conventional-changelog/-/conventional-changelog-0.1.1.tgz#48d2227ca65c354cba4be60754ea531afd0c3718"
+  dependencies:
+    compare-func "^1.3.2"
+    execa "^0.10.0"
+    q "^1.5.1"
+
 "@vue/test-utils@^1.0.0-beta.16":
   version "1.0.0-beta.21"
   resolved "https://registry.yarnpkg.com/@vue/test-utils/-/test-utils-1.0.0-beta.21.tgz#fe1ee11ce16072da7ef29420df4aa5c11f4560ff"
@@ -2397,6 +2405,10 @@ chardet@^0.4.0:
   version "0.4.2"
   resolved "https://registry.yarnpkg.com/chardet/-/chardet-0.4.2.tgz#b5473b33dc97c424e5d98dc87d55d4d8a29c8bf2"
 
+chardet@^0.7.0:
+  version "0.7.0"
+  resolved "https://registry.yarnpkg.com/chardet/-/chardet-0.7.0.tgz#90094849f0937f2eedc2425d0d28a9e5f0cbad9e"
+
 chokidar@^2.0.2, chokidar@^2.0.3:
   version "2.0.4"
   resolved "https://registry.yarnpkg.com/chokidar/-/chokidar-2.0.4.tgz#356ff4e2b0e8e43e322d18a372460bbcf3accd26"
@@ -2645,7 +2657,7 @@ commondir@^1.0.1:
   version "1.0.1"
   resolved "https://registry.yarnpkg.com/commondir/-/commondir-1.0.1.tgz#ddd800da0c66127393cca5950ea968a3aaf1253b"
 
-compare-func@^1.3.1:
+compare-func@^1.3.1, compare-func@^1.3.2:
   version "1.3.2"
   resolved "https://registry.yarnpkg.com/compare-func/-/compare-func-1.3.2.tgz#99dd0ba457e1f9bc722b12c08ec33eeab31fa648"
   dependencies:
@@ -3872,6 +3884,14 @@ external-editor@^2.0.4:
     iconv-lite "^0.4.17"
     tmp "^0.0.33"
 
+external-editor@^3.0.0:
+  version "3.0.3"
+  resolved "https://registry.yarnpkg.com/external-editor/-/external-editor-3.0.3.tgz#5866db29a97826dbe4bf3afd24070ead9ea43a27"
+  dependencies:
+    chardet "^0.7.0"
+    iconv-lite "^0.4.24"
+    tmp "^0.0.33"
+
 extglob@^0.3.1:
   version "0.3.2"
   resolved "https://registry.yarnpkg.com/extglob/-/extglob-0.3.2.tgz#2e18ff3d2f49ab2765cec9023f011daa8d8349a1"
@@ -4574,6 +4594,12 @@ iconv-lite@^0.4.17, iconv-lite@^0.4.4:
   dependencies:
     safer-buffer ">= 2.1.2 < 3"
 
+iconv-lite@^0.4.24:
+  version "0.4.24"
+  resolved "https://registry.yarnpkg.com/iconv-lite/-/iconv-lite-0.4.24.tgz#2022b4b25fbddc21d2f524974a474aafe733908b"
+  dependencies:
+    safer-buffer ">= 2.1.2 < 3"
+
 icss-replace-symbols@^1.1.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/icss-replace-symbols/-/icss-replace-symbols-1.1.0.tgz#06ea6f83679a7749e386cfe1fe812ae5db223ded"
@@ -4693,6 +4719,24 @@ inquirer@^3.0.6, inquirer@^3.2.2:
     strip-ansi "^4.0.0"
     through "^2.3.6"
 
+inquirer@^6.2.0:
+  version "6.2.0"
+  resolved "https://registry.yarnpkg.com/inquirer/-/inquirer-6.2.0.tgz#51adcd776f661369dc1e894859c2560a224abdd8"
+  dependencies:
+    ansi-escapes "^3.0.0"
+    chalk "^2.0.0"
+    cli-cursor "^2.1.0"
+    cli-width "^2.0.0"
+    external-editor "^3.0.0"
+    figures "^2.0.0"
+    lodash "^4.17.10"
+    mute-stream "0.0.7"
+    run-async "^2.2.0"
+    rxjs "^6.1.0"
+    string-width "^2.1.0"
+    strip-ansi "^4.0.0"
+    through "^2.3.6"
+
 invariant@^2.2.0, invariant@^2.2.2, invariant@^2.2.4:
   version "2.2.4"
   resolved "https://registry.yarnpkg.com/invariant/-/invariant-2.2.4.tgz#610f3c92c9359ce1db616e538008d23ff35158e6"
@@ -6110,6 +6154,10 @@ [email protected]:
   version "0.3.0"
   resolved "https://registry.yarnpkg.com/media-typer/-/media-typer-0.3.0.tgz#8710d7af0aa626f8fffa1ce00168545263255748"
 
+medium-zoom@^0.4.0:
+  version "0.4.0"
+  resolved "http://registry.npmjs.org/medium-zoom/-/medium-zoom-0.4.0.tgz#8e13c9b754903c0c903220611af0d3cd373a4222"
+
 mem@^1.1.0:
   version "1.1.0"
   resolved "https://registry.yarnpkg.com/mem/-/mem-1.1.0.tgz#5edd52b485ca1d900fe64895505399a0dfa45f76"