From f277ac213e12db4eb13f058da12a8d499535e769 Mon Sep 17 00:00:00 2001 From: Matt Anglin Date: Tue, 2 Mar 2021 13:52:52 -0800 Subject: [PATCH] Allow custom commit messages for version bump --- README.md | 10 ++++++++++ action.yml | 4 ++++ index.js | 10 ++++++---- 3 files changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1a9f7d7..6da41fb 100644 --- a/README.md +++ b/README.md @@ -86,3 +86,13 @@ Make sure you use the `actions/checkout@v2` action! with: target-branch: 'master' ``` + +**commit-message:** Set a custom commit message for version bump commit. Useful for skipping additional workflows run on push. Example: +```yaml +- name: 'Automated Version Bump' + uses: 'phips28/gh-action-bump-version@master' + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + with: + commit-message: 'CI: bumps version to {{version}} [skip ci]' +``` \ No newline at end of file diff --git a/action.yml b/action.yml index 06a65e3..2c83c3f 100644 --- a/action.yml +++ b/action.yml @@ -39,6 +39,10 @@ inputs: description: 'Set a default version bump to use' default: 'patch' required: false + commit-message: + description: 'Set a custom commit message for version bump commit' + deafult: '' + required: false outputs: newTag: description: 'The newly created tag' diff --git a/index.js b/index.js index 9d799f4..291e194 100644 --- a/index.js +++ b/index.js @@ -18,9 +18,11 @@ Toolkit.run(async tools => { const messages = event.commits ? event.commits.map(commit => commit.message + '\n' + commit.body) : [] - const commitMessage = 'version bump to' + const commitMessage = process.env['INPUT_COMMIT-MESSAGE'] || 'ci: version bump to {{version}}' console.log('messages:', messages) - const isVersionBump = messages.map(message => message.toLowerCase().includes(commitMessage)).includes(true) + const commitMessageRegex = new RegExp(commitMessage.replace('{{version}}', 'v\d\.\d\.\d'), 'ig'); + const isVersionBump = messages.find(message => commitMessageRegex.test(message)) !== undefined + if (isVersionBump) { tools.exit.success('No action necessary!') return @@ -89,7 +91,7 @@ Toolkit.run(async tools => { ['version', '--allow-same-version=true', '--git-tag-version=false', current]) console.log('current:', current, '/', 'version:', version) let newVersion = execSync(`npm version --git-tag-version=false ${version}`).toString().trim() - await tools.runInWorkspace('git', ['commit', '-a', '-m', `ci: ${commitMessage} ${newVersion}`]) + await tools.runInWorkspace('git', ['commit', '-a', '-m', commitMessage.replace('{{version}}', newVersion)]) // now go to the actual branch to perform the same versioning if (isPullRequest) { @@ -106,7 +108,7 @@ Toolkit.run(async tools => { console.log(`::set-output name=newTag::${newVersion}`) try { // to support "actions/checkout@v1" - await tools.runInWorkspace('git', ['commit', '-a', '-m', `ci: ${commitMessage} ${newVersion}`]) + await tools.runInWorkspace('git', ['commit', '-a', '-m', commitMessage.replace('{{version}}', newVersion)]) } catch (e) { console.warn('git commit failed because you are using "actions/checkout@v2"; ' + 'but that doesnt matter because you dont need that git commit, thats only for "actions/checkout@v1"')