workflow: document release process [ci skip]

This commit is contained in:
Evan You
2018-07-24 10:08:00 -04:00
parent 7d46db926a
commit 0effec2b97

View File

@@ -1,3 +1,34 @@
/**
How to do a release:
1. Make sure you have publish access for all packages:
- You must be in the CLI team in the npm @vue organization
- You must have publish access to vue-cli-version-marker
- 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 `dev` branch.
5. Go to GitHub and verify that the changelog is live.
6. Go to GitHub releases page and publish the release (this is required for
the release to show up in the issue helper)
*/
process.env.VUE_CLI_RELEASE = true
const execa = require('execa')