Skip to content

Commit

Permalink
fix(create-release-branch): improve error description
Browse files Browse the repository at this point in the history
  • Loading branch information
DaRaFF committed Apr 27, 2020
1 parent 3fd9ac9 commit 4f5de50
Showing 1 changed file with 34 additions and 1 deletion.
35 changes: 34 additions & 1 deletion lib/shell/sh-is-release-branch-creation-allowed.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,40 @@ module.exports = function (dep) {
if (!isPatchAllowed) {
const msg = `
It's not allowed to create a patch version based on ${argv.baseTag}
Please first execute 'npx @daraff/create-bump-pr@latest' to bump the version on master
Please first execute 'npx @daraff/create-bump-pr@latest' to bump the tag version on master
----------------------------------------------
Workflow for a Bump PR / Create Release Branch
----------------------------------------------
1) Execute npx @daraff/create-bump-pr (see example and option description)
- the script automatically updates the README.md with an empty line to indicate a change
- the script create a PR to incite a new minor version
2) Go to github and merge the PR
3) Wait until the merged PR on master created a new minor github tag
4) Go to your repo again
5) Execute git pull --tags
6) Execute npx @livingdocs/release-tools@latest create-release-branch again
-------
Example
-------
npx @daraff/create-bump-pr \
--token=<your-gh-token> \
--owner=<gh-owner> \
--repo=<gh-repo>
-------
Options
-------
****token****
You need a personal github access token to create a bump PR.
Go to https://github.com/settings/tokens/new to create a token with 'repo' scope
****owner****
The owner of the repository (e.g. livingdocsIO)
****repo****
The repository name (e.g. livingdocs-server)
`
return reject(new Error(msg))
}
Expand Down

0 comments on commit 4f5de50

Please sign in to comment.