UNPKG

release-automation

Version:

An opinionated CLI for release automation

github.com/eowino/release-automation

58 lines (35 loc) • 2.43 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
# release-automation [![npm version](https://badge.fury.io/js/release-automation.svg)](https://npmjs.org/package/release-automation 'View this project on npm') ## What An opinionated CLI for release automation ## Prerequisites This CLI requires Node 9.11.2 or higher. ## Installation **BEFORE YOU INSTALL:** please read the [prerequisites](#prerequisites) ```bash npm install -g release-automation ``` ## Usage Then simply run the following in your `git` instantiated directory ```bash release-automation ``` Use any of the following flags to print the version of the module: `-v`, `--v`, `-version`, `--version` ## Steps 1. Prompts you for a branch name. If you don't provide one, the current branch will be used. If you do provide a branch name, you will be asked which branch to base it on. The master branch will be used as default. Given both are provided, a new branch will be created. 2. Select the branches you want to merge into the selected branch from step 1. Also optional, as you may have done this already. 3. It will attempt to merge the selected branches into the current branch. All successful merges will be printed displayed. If any merge conflicts are raised, the process will exit and give you the chance to resolve them. Once resolved, you can run the script again. 4. Prompts you for the next version of your release. It will suggest one by looking at your current version in `package.json` and the branches you have selected. For example, if you're currently on version `1.0.0`, and you have selected 2 branches where the names begin with `feat/` and 1 branch that begins with `fix/`, then the suggested version will be `1.2.1`. The suggested version will be used as the default version for the next release **if** you don't provide one. Other semver versions are not suggested for simplicity, but you may specify. 5. It will then set `npm version` which will subsequently also `git tag` the release. If that fails (e.g. package.json doesn't exist), it will set the git tag version manually. 6. The current branch will then be pushed with tags to github. 7. Prompts you if you'd like to create a PR into a staging branch, if you would, provide the staging branch 8. A Github link will be printed that directs you to the PR page for the branch you specified into the staging branch 9. A Github link to the release notes page for that release will also be printed.