release: v5.2.0

* docs: update README.md [skip ci]

* docs: update .all-contributorsrc [skip ci]

* [auto] docs: update contributors badge

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>

.all-contributorsrc

@@ -156,6 +156,24 @@
       "contributions": [
         "bug"
       ]
+    },
+    {
+      "login": "Chocrates",
+      "name": "Chris McIntosh",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/1758164?v=4",
+      "profile": "https://github.com/Chocrates",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "kbsali",
+      "name": "Kevin Saliou",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/53676?v=4",
+      "profile": "https://github.com/kbsali",
+      "contributions": [
+        "ideas"
+      ]
     }
   ],
   "contributorsPerLine": 7,

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [5.2.0] - 2020-11-11
+### Added:
+-  New `push` option: this lets you tell the action whether to push commit and tags to the repo. The default value is `true`, so that the default behavior is not changed. (issue #86)
+
 ## [5.1.2] - 2020-11-10
 ### Fixed:
 - Fixed an issue with the build (issue #88)
@@ -120,7 +124,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 First release
 
 #
-[Unreleased]: https://github.com/EndBug/add-and-commit/compare/v5.1.2...HEAD
+[Unreleased]: https://github.com/EndBug/add-and-commit/compare/v5.2.0...HEAD
 [1.0.0]: https://github.com/EndBug/add-and-commit/tree/v1.0.0
 [2.0.0]: https://github.com/EndBug/add-and-commit/compare/v1.0.0...v2.0.0
 [2.1.0]: https://github.com/EndBug/add-and-commit/compare/v2.0.0...v2.1.0
@@ -144,3 +148,4 @@ First release
 [5.1.0]: https://github.com/EndBug/add-and-commit/compare/v5.0.0...v5.1.0
 [5.1.1]: https://github.com/EndBug/add-and-commit/compare/v5.1.0...v5.1.1
 [5.1.2]: https://github.com/EndBug/add-and-commit/compare/v5.1.1...v5.1.2
+[5.2.0]: https://github.com/EndBug/add-and-commit/compare/v5.1.2...v5.2.0

README.md

@@ -1,6 +1,6 @@
 # Add & Commit
 <a href="https://github.com/search?o=desc&q=EndBug%2Fadd-and-commit+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code" target="_blank" title="Public workflows that use this action."><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3DEndBug%2Fadd-and-commit%26badge%3Dtrue" alt="Public workflows that use this action."></a>
-[![All Contributors](https://img.shields.io/badge/all_contributors-16-orange.svg?style=flat)](#contributors-)
+[![All Contributors](https://img.shields.io/badge/all_contributors-18-orange.svg?style=flat)](#contributors-)
 
 You can use this GitHub Action to commit changes made in your workflow run directly to your repo: for example, you use it to lint your code, update documentation, commit updated builds, etc....
 
@@ -42,6 +42,10 @@ Add a step like this to your workflow:
     # Default: '--no-rebase'
     pull_strategy: '--no-rebase or --no-ff or --rebase'
 
+    # Whether to push the commit and, if any, its tags to the repo (only `true` and `false` are accepted)
+    # Default: true
+    push: false
+
     # The arguments for the `git rm` command (see the paragraph below for more info)
     # Default: ''
     remove: "./dir/old_file.js"
@@ -175,6 +179,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
   <tr>
     <td align="center"><a href="https://github.com/Cyberbeni"><img src="https://avatars1.githubusercontent.com/u/8356175?v=4" width="100px;" alt=""/><br /><sub><b>Benedek Kozma</b></sub></a><br /><a href="#ideas-Cyberbeni" title="Ideas, Planning, & Feedback">🤔</a></td>
     <td align="center"><a href="https://github.com/coffeegoddd"><img src="https://avatars3.githubusercontent.com/u/43383835?v=4" width="100px;" alt=""/><br /><sub><b>Dustin Brown</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3Acoffeegoddd" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/Chocrates"><img src="https://avatars1.githubusercontent.com/u/1758164?v=4" width="100px;" alt=""/><br /><sub><b>Chris McIntosh</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3AChocrates" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/kbsali"><img src="https://avatars0.githubusercontent.com/u/53676?v=4" width="100px;" alt=""/><br /><sub><b>Kevin Saliou</b></sub></a><br /><a href="#ideas-kbsali" title="Ideas, Planning, & Feedback">🤔</a></td>
   </tr>
 </table>
 

action.yml

@@ -26,6 +26,9 @@ inputs:
     description: The flag used on the pull strategy
     required: false
     default: '--no-rebase'
+  push:
+    description: Whether to push the commit and, if any, its tags to the repo
+    required: false
   remove:
     description: Arguments for the git rm command
     required: false

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "add-and-commit",
-  "version": "5.1.2",
+  "version": "5.2.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "add-and-commit",
-  "version": "5.1.2",
+  "version": "5.2.0",
   "description": "Add & commit files from a path directly from GitHub Actions",
   "main": "lib/index.js",
   "scripts": {

src/inputs.ts

@@ -1,3 +1,3 @@
 // WARNING: this file is auto-generated by scripts/inputs.ts (npm run inputs), any manual edit will be overwritten.
 
-export type Input = 'add' | 'author_name' | 'author_email' | 'branch' | 'cwd' | 'message' | 'pull_strategy' | 'remove' | 'signoff' | 'tag'
+export type Input = 'add' | 'author_name' | 'author_email' | 'branch' | 'cwd' | 'message' | 'pull_strategy' | 'push' | 'remove' | 'signoff' | 'tag'

src/main.ts

@@ -66,21 +66,23 @@ console.log(`Running in ${baseDir}`);
       await git.tag(getInput('tag').split(' '), log)
     } else info('> No tag info provided.')
 
-    info('> Pushing commit to repo...')
-    await git.push('origin', getInput('branch'), { '--set-upstream': null }, log)
+    if (getInput('push')) {
+      info('> Pushing commit to repo...')
+      await git.push('origin', getInput('branch'), { '--set-upstream': null }, log)
 
-    if (getInput('tag')) {
-      info('> Pushing tags to repo...')
-      await git.pushTags('origin', (e, d?) => log(undefined, e || d)).catch(() => {
-        info('> Tag push failed: deleting remote tag and re-pushing...')
-        return git.push(undefined, undefined, {
-          '--delete': null,
-          'origin': null,
-          [getInput('tag').split(' ').filter(w => !w.startsWith('-'))[0]]: null
-        }, log)
-          .pushTags('origin', log)
-      })
-    } else info('> No tags to push.')
+      if (getInput('tag')) {
+        info('> Pushing tags to repo...')
+        await git.pushTags('origin', (e, d?) => log(undefined, e || d)).catch(() => {
+          info('> Tag push failed: deleting remote tag and re-pushing...')
+          return git.push(undefined, undefined, {
+            '--delete': null,
+            'origin': null,
+            [getInput('tag').split(' ').filter(w => !w.startsWith('-'))[0]]: null
+          }, log)
+            .pushTags('origin', log)
+        })
+      } else info('> No tags to push.')
+    } else info('> Not pushing anything.')
 
     endGroup()
     info('> Task completed.')
@@ -175,13 +177,32 @@ async function checkInputs() {
   // #endregion
 
   // #region signoff
-  if (getInput('signoff')) try {
-    const parsed = JSON.parse(getInput('signoff'))
-    if (typeof parsed == 'boolean' && !parsed)
+  if (getInput('signoff')) {
+    const parsed = parseBool(getInput('signoff'))
+
+    if (parsed === undefined)
+      throw new Error(`"${getInput('signoff')}" is not a valid value for the 'signoff' input: only "true" and "false" are allowed.`)
+
+    if (!parsed)
       setInput('signoff', undefined)
+
     debug(`Current signoff option: ${getInput('signoff')} (${typeof getInput('signoff')})`)
-  } catch {
-    throw new Error(`"${getInput('signoff')}" is not a valid value for the 'signoff' input: only "true" and "false" are allowed.`)
+  }
+
+  // #endregion  
+
+  // #region push
+  setDefault('push', 'true')
+  if (getInput('push')) { // It's just to scope the parsed constant
+    const parsed = parseBool(getInput('push'))
+
+    if (parsed === undefined)
+      throw new Error(`"${getInput('push')}" is not a valid value for the 'push' input: only "true" and "false" are allowed.`)
+
+    if (!parsed)
+      setInput('push', undefined)
+
+    debug(`Current push option: ${getInput('push')} (${typeof getInput('push')})`)
   }
   // #endregion
 }
@@ -190,6 +211,14 @@ function getInput(name: Input) {
   return getInputCore(name)
 }
 
+function parseBool(value: any) {
+  try {
+    const parsed = JSON.parse(value)
+    if (typeof parsed == 'boolean')
+      return parsed
+  } catch { }
+}
+
 function log(err: any | Error, data?: any) {
   if (data) console.log(data)
   if (err) error(err)