release: v7.4.0

* feat: add pull input and deprecate pull_strategy

* docs(README): update pull docs

* fix: fix DeepScan issue

* fix: minor formatting change

.all-contributorsrc

@@ -250,6 +250,43 @@
       "contributions": [
         "bug"
       ]
+    },
+    {
+      "login": "CWSites",
+      "name": "Matt H",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1242102?v=4",
+      "profile": "https://www.linkedin.com/in/cwsites",
+      "contributions": [
+        "doc",
+        "ideas"
+      ]
+    },
+    {
+      "login": "danielwerg",
+      "name": "danielwerg",
+      "avatar_url": "https://avatars.githubusercontent.com/u/35052399?v=4",
+      "profile": "https://github.com/danielwerg",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "koppor",
+      "name": "Oliver Kopp",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1366654?v=4",
+      "profile": "https://orcid.org/0000-0001-6962-4290",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "Glidias",
+      "name": "Glenn Ko",
+      "avatar_url": "https://avatars.githubusercontent.com/u/190195?v=4",
+      "profile": "https://github.com/Glidias",
+      "contributions": [
+        "ideas"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.eslintrc.js

@@ -17,6 +17,7 @@ module.exports = {
     'prettier/prettier': 'warn',
     'no-cond-assign': [2, 'except-parens'],
     'no-unused-vars': 0,
+    'no-redeclare': 0,
     '@typescript-eslint/no-unused-vars': 1,
     'no-empty': [
       'error',

CHANGELOG.md

@@ -7,6 +7,24 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [7.4.0] - 2021-09-30
+
+### Added:
+
+- Added `pull` input: you can use it to change the arguments of the `git pull` command (#294)
+
+### Changed:
+
+- Deprecated `pull_strategy`: use `pull` instead (#294)
+
+## [7.3.0] - 2021-09-06
+
+### Added:
+
+- Added custom committer support via the `committer_name` and `committer_email` inputs (#264)
+- Added `commit_sha` output (#275)
+- Added `pathspec_error_handling` input (#280)
+
 ## [7.2.1] - 2021-05-11
 
 ### Fixed:
@@ -248,7 +266,7 @@ First release
 
 #
 
-[unreleased]: https://github.com/EndBug/add-and-commit/compare/v7.2.1...HEAD
+[unreleased]: https://github.com/EndBug/add-and-commit/compare/v7.4.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
@@ -283,3 +301,5 @@ First release
 [7.1.2]: https://github.com/EndBug/add-and-commit/compare/v7.1.1...v7.1.2
 [7.2.0]: https://github.com/EndBug/add-and-commit/compare/v7.1.2...v7.2.0
 [7.2.1]: https://github.com/EndBug/add-and-commit/compare/v7.2.0...v7.2.1
+[7.3.0]: https://github.com/EndBug/add-and-commit/compare/v7.2.1...v7.3.0
+[7.4.0]: https://github.com/EndBug/add-and-commit/compare/v7.3.0...v7.4.0

README.md

@@ -1,6 +1,6 @@
 # Add & Commit
 
-[![Public workflows that use this action.](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)](https://github.com/search?o=desc&q=EndBug+add-and-commit+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code)
+[![Public workflows that use this action.](https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3DEndBug%2Fadd-and-commit%26badge%3Dtrue)](https://github.com/search?o=desc&q=EndBug+add-and-commit+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code)
 [![All Contributors](https://img.shields.io/github/all-contributors/EndBug/add-and-commit)](#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....
@@ -8,30 +8,38 @@ You can use this GitHub Action to commit changes made in your workflow run direc
 This is **heavily** inspired by [git-auto-commit-action](https://github.com/stefanzweifel/git-auto-commit-action) (by [Stefan Zweifel](https://github.com/stefanzweifel)): that action automatically detects changed files and commits them. While this is useful for most situations, this doesn't commit untracked files and can sometimes commit unintended changes (such as `package-lock.json` or similar, that may have happened during previous steps).  
 This action lets you choose the path that you want to use when adding & committing changes so that it works as you would normally do using `git` on your machine.
 
-## Usage
+## Inputs
 
 Add a step like this to your workflow:
 
 ```yaml
-- uses: EndBug/add-and-commit@v7 # You can change this to use a specific version
+- uses: EndBug/add-and-commit@v7 # You can change this to use a specific version.
   with:
     # The arguments for the `git add` command (see the paragraph below for more info)
     # Default: '.'
     add: 'src'
 
-    # The name of the user that will be displayed as the author of the commit
+    # The name of the user that will be displayed as the author of the commit.
     # Default: depends on the default_author input
-    author_name: Your Name
+    author_name: Author Name
 
-    # The email of the user that will be displayed as the author of the commit
+    # The email of the user that will be displayed as the author of the commit.
     # Default: depends on the default_author input
     author_email: mail@example.com
 
-    # Name of the branch to use, if different from the one that triggered the workflow
+    # The name of the branch to use, if different from the one that triggered the workflow.
     # Default: the branch that triggered the run
     branch: some-branch
 
-    # The local path to the directory where your repository is located. You should use actions/checkout first to set it up
+    # The name of the custom committer you want to use, if different from the author of the commit.
+    # Default: the name of the author (set with either author_name or default_author)
+    committer_name: Committer Name
+
+    # The email of the custom committer you want to use, if different from the author of the commit.
+    # Default: the email of the author (set with either author_email or default_author)
+    committer_email: mail@example.com
+
+    # The local path to the directory where your repository is located. You should use actions/checkout first to set it up.
     # Default: '.'
     cwd: './path/to/the/repo'
 
@@ -39,16 +47,23 @@ Add a step like this to your workflow:
     # - github_actor -> UserName <UserName@users.noreply.github.com>
     # - user_info -> Your Display Name <your-actual@email.com>
     # - github_actions -> github-actions <email associated with the github logo>
-    # Default:
+    # Default: github_actor
     default_author: github_actor
 
-    # The message for the commit
+    # The message for the commit.
     # Default: 'Commit from GitHub Actions (name of the workflow)'
     message: 'Your commit message'
 
-    # The flag used on the pull strategy. Use NO-PULL to avoid the action pulling at all.
+    # The way the action should handle pathspec errors from the add and remove commands. Three options are available:
+    # - ignore -> errors will be logged but the step won't fail
+    # - exitImmediately -> the action will stop right away, and the step will fail
+    # - exitAtEnd -> the action will go on, every pathspec error will be logged at the end, the step will fail.
+    # Default: ignore
+    pathspec_error_handling: ignore
+
+    # Arguments for the git pull command. Use NO-PULL to avoid the action pulling at all.
     # Default: '--no-rebase'
-    pull_strategy: 'NO-PULL or --no-rebase or --no-ff or --rebase'
+    pull: 'NO-PULL or --rebase --autostash ...'
 
     # Whether to push the commit and, if any, its tags to the repo. It can also be used to set the git push arguments (see the paragraph below for more info)
     # Default: true
@@ -58,7 +73,7 @@ Add a step like this to your workflow:
     # Default: ''
     remove: './dir/old_file.js'
 
-    # Whether to use the --signoff option on `git commit` (only `true` and `false` are accepted)
+    # Whether to use the --signoff option on `git commit` (only boolean values accepted*)
     # Default: false
     signoff: true
 
@@ -72,19 +87,19 @@ Add a step like this to your workflow:
 Multiple options let you provide the git arguments that you want the action to use. It's important to note that these arguments **are not actually used with a CLI command**, but they are parsed by a package called [`string-argv`](https://npm.im/string-argv), and then used with [`simple-git`](https://npm.im/simple-git).  
 What does this mean for you? It means that string that contain a lot of nested quotes may be parsed incorrectly, and that specific ways of declaring arguments may not be supported by this libraries. If you're having issues with your argument strings you can check whether they're being parsed correctly either by [enabling debug logging](https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging) for your workflow runs or by testing it directly with `string-argv` ([RunKit demo](https://npm.runkit.com/string-argv)): if each argument and option is aprsed correctly you'll see an array where every string is an option or value.
 
-### Adding files:
+### Adding files
 
 The action adds files using a regular `git add` command, so you can put every kind of argument in the `add` option. For example, if you want to force-add a file: `./path/to/file.txt --force`.  
 The script will not stop if one of the git commands doesn't match any file. E.g.: if your command shows a "fatal: pathspec 'yourFile' did not match any files" error the action will go on.  
 You can also use JSON or YAML arrays (e.g. `'["first", "second"]'`, `"['first', 'second']"`) to make the action run multiple `git add` commands: the action will log how your input has been parsed. Please mind that your input still needs to be a string because of how GitHub Actions works with inputs: just write your array inside the string, the action will parse it later.
 
-### Deleting files:
+### Deleting files
 
 You can delete files with the `remove` option: that runs a `git rm` command that will stage the files in the given path for removal. As with the `add` argument, you can use every option `git rm` allows (e.g. add `--force` to ignore `.gitignore` rules).  
 The script will not stop if one of the git commands doesn't match any file. E.g.: if your command shows a "fatal: pathspec 'yourFile' did not match any files" error the action will go on.  
 You can also use JSON or YAML arrays (e.g. `'["first", "second"]'`, `"['first', 'second']"`) to make the action run multiple `git rm` commands: the action will log how your input has been parsed. Please mind that your input still needs to be a string because of how GitHub Actions works with inputs: just write your array inside the string, the action will parse it later.
 
-### Pushing:
+### Pushing
 
 By default the action runs the following command: `git push origin ${branch input} --set-upstream`. You can use the `push` input to modify this behavior, here's what you can set it to:
 
@@ -95,11 +110,11 @@ By default the action runs the following command: `git push origin ${branch inpu
 
 One way to use this is if you want to force push to a branch of your repo: you'll need to set the `push` input to, for example, `origin yourBranch --force`.
 
-### Tagging:
+### Tagging
 
 You can use the `tag` option to enter the arguments for a `git add` command. In order for the action to isolate the tag name from the rest of the arguments, it should be the first word not preceded by an hyphen (e.g. `-a tag-name -m "some other stuff"` is ok).
 
-### Tokens:
+### Tokens
 
 When pushing, the action uses the token that the local git repository has been configured with: that means that if you want to change it you'll need to do it in the steps that run before this action. For example: if you set up your repo with [`actions/checkout`](https://github.com/actions/checkout/) then you have to add the token there.  
 Changing the token with which the repo is configured can be useful if you want to run CI checks on the commit pushed by this action; anyway, it has to be set up outside of this action.
@@ -117,17 +132,18 @@ Some users reported that they were getting an error:
 
 If you're getting this error and you're using `actions/checkout@v1`, try upgrading to `actions/checkout@v2`. If you're still having problems after upgrading, feel free to open an issue. Issue ref: [#146](https://github.com/EndBug/add-and-commit/issues/146)
 
-### Outputs:
+## Outputs
 
 The action provides these outputs:
 
 - `committed`: whether the action has created a commit (`'true'` or `'false'`)
+- `commit_sha`: the short 7-digit sha of the commit that has just been created
 - `pushed`: whether the action has pushed to the remote (`'true'` or `'false'`)
 - `tagged`: whether the action has created a tag (`'true'` or `'false'`)
 
 For more info on how to use outputs, see ["Context and expression syntax"](https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions).
 
-### Examples:
+## Examples
 
 If you don't want to use your GitHub username for the CI commits, you can use the `default_author` option to make it appear as if it was made by "github-actions"
 
@@ -139,11 +155,32 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: EndBug/add-and-commit@v7.0.0
+      - uses: EndBug/add-and-commit@v7
         with:
           default_author: github_actions
 ```
 
+You can also use the `committer_name` and `committer_email` inputs to make it appear as if GitHub Actions is the committer, here are a couple of example steps:
+
+<img src="https://user-images.githubusercontent.com/26386270/130594168-1d910710-e2d0-4b06-9324-cbe5dde59154.png" height=70/>
+
+```yaml
+- uses: EndBug/add-and-commit@v7
+  with:
+    message: Show GitHub Actions logo
+    committer_name: GitHub Actions
+    committer_email: actions@github.com
+```
+
+<img src="https://user-images.githubusercontent.com/26386270/130594443-b881fae7-3064-4020-a4cc-6db37ef0df65.png" height=70/>
+
+```yaml
+- uses: EndBug/add-and-commit@v7
+  with:
+    message: Show GitHub logo
+    committer_name: GitHub Actions
+    committer_email: 41898282+github-actions[bot]@users.noreply.github.com
+```
 
 Do you want to lint your JavaScript files, located in the `src` folder, with ESLint, so that fixable changes are done without your intervention? You can use a workflow like this:
 
@@ -248,6 +285,12 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <td align="center"><a href="https://xenoterracide.com"><img src="https://avatars.githubusercontent.com/u/5517?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Caleb Cushing</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3Axenoterracide" title="Bug reports">🐛</a></td>
     <td align="center"><a href="https://ruohola.dev"><img src="https://avatars.githubusercontent.com/u/33625218?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Eero Ruohola</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3Aruohola" title="Bug reports">🐛</a> <a href="#ideas-ruohola" title="Ideas, Planning, & Feedback">🤔</a></td>
     <td align="center"><a href="https://github.com/vincentchu12"><img src="https://avatars.githubusercontent.com/u/23532586?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Vincent Chu</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3Avincentchu12" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://www.linkedin.com/in/cwsites"><img src="https://avatars.githubusercontent.com/u/1242102?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Matt H</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/commits?author=CWSites" title="Documentation">📖</a> <a href="#ideas-CWSites" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/danielwerg"><img src="https://avatars.githubusercontent.com/u/35052399?v=4?s=100" width="100px;" alt=""/><br /><sub><b>danielwerg</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/commits?author=danielwerg" title="Documentation">📖</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://orcid.org/0000-0001-6962-4290"><img src="https://avatars.githubusercontent.com/u/1366654?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Oliver Kopp</b></sub></a><br /><a href="#ideas-koppor" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/Glidias"><img src="https://avatars.githubusercontent.com/u/190195?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Glenn Ko</b></sub></a><br /><a href="#ideas-Glidias" title="Ideas, Planning, & Feedback">🤔</a></td>
   </tr>
 </table>
 

action.yml

@@ -15,6 +15,12 @@ inputs:
   branch:
     description: Name of the branch to use, if different from the one that triggered the workflow
     required: false
+  committer_name:
+    description: The name of the custom committer you want to use
+    required: false 
+  committer_email:
+    description: The email of the custom committer you want to use
+    required: false
   cwd:
     description: The directory where your repository is located. You should use actions/checkout first to set it up
     required: false
@@ -26,10 +32,19 @@ inputs:
   message:
     description: The message for the commit
     required: false
+  pathspec_error_handling:
+    description: The way the action should handle pathspec errors from the add and remove commands.
+    required: false
+    default: ignore
+  pull:
+    description: Arguments for the git pull command. Use NO-PULL to avoid the action pulling at all.
+    required: false
+    # Default value currently set in runtime
+    # default: '--no-rebase'
   pull_strategy:
     description: The flag used on the pull strategy. Use NO-PULL to avoid the action pulling at all.
     required: false
-    default: '--no-rebase'
+    deprecationMessage: The 'pull_strategy' input is deprecated, please use 'pull'
   push:
     description: Whether to push the commit and, if any, its tags to the repo. It can also be used to set the git push arguments (more info in the README)
     required: false
@@ -53,6 +68,8 @@ inputs:
 outputs:
   committed:
     description: Whether the action has created a commit.
+  commit_sha:
+    description: The SHA of the commit that has been created.
   pushed:
     description: Whether the action has pushed to the remote.
   tagged:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "add-and-commit",
-  "version": "7.2.1",
+  "version": "7.4.0",
   "private": true,
   "description": "Add & commit files from a path directly from GitHub Actions",
   "main": "lib/index.js",
@@ -31,26 +31,26 @@
   },
   "homepage": "https://github.com/EndBug/add-and-commit#readme",
   "dependencies": {
-    "@actions/core": "^1.2.7",
+    "@actions/core": "^1.5.0",
     "actions-toolkit": "github:EndBug/actions-toolkit#core-actions",
     "js-yaml": "^4.1.0",
     "simple-git": "^2.27.0",
     "string-argv": "^0.3.1"
   },
   "devDependencies": {
-    "@types/js-yaml": "^4.0.1",
+    "@types/js-yaml": "^4.0.3",
     "@types/node": "^12.12.54",
-    "@typescript-eslint/eslint-plugin": "^4.23.0",
-    "@typescript-eslint/parser": "^4.23.0",
-    "@vercel/ncc": "^0.28.3",
+    "@typescript-eslint/eslint-plugin": "^4.31.2",
+    "@typescript-eslint/parser": "^4.32.0",
+    "@vercel/ncc": "^0.31.1",
     "all-contributors-cli": "^6.20.0",
-    "eslint": "^7.26.0",
+    "eslint": "^7.32.0",
     "eslint-config-prettier": "^8.3.0",
-    "eslint-plugin-prettier": "^3.4.0",
-    "husky": "^6.0.0",
-    "prettier": "^2.3.0",
-    "ts-node": "^9.1.1",
-    "typescript": "^4.2.4",
+    "eslint-plugin-prettier": "^4.0.0",
+    "husky": "^7.0.2",
+    "prettier": "^2.4.1",
+    "ts-node": "^10.2.1",
+    "typescript": "^4.4.3",
     "yamljs": "^0.3.0"
   }
 }

src/main.ts

@@ -1,21 +1,23 @@
 import * as core from '@actions/core'
 import path from 'path'
-import simpleGit, { Response } from 'simple-git'
+import simpleGit, { CommitSummary, Response } from 'simple-git'
 import YAML from 'js-yaml'
 import {
   getInput,
   getUserInfo,
-  Input,
+  input,
   log,
   matchGitArgs,
   outputs,
-  parseBool,
   readJSON,
   setOutput
 } from './util'
 
 const baseDir = path.join(process.cwd(), getInput('cwd') || '')
 const git = simpleGit({ baseDir })
+
+const exitErrors: Error[] = []
+
 core.info(`Running in ${baseDir}`)
 ;(async () => {
   await checkInputs().catch(core.setFailed)
@@ -23,14 +25,16 @@ core.info(`Running in ${baseDir}`)
   core.startGroup('Internal logs')
   core.info('> Staging files...')
 
+  const peh = getInput('pathspec_error_handling')
+
   if (getInput('add')) {
     core.info('> Adding files...')
-    await add()
+    await add(peh == 'ignore' ? 'pathspec' : 'none')
   } else core.info('> No files to add.')
 
   if (getInput('remove')) {
     core.info('> Removing files...')
-    await remove()
+    await remove(peh == 'ignore' ? 'pathspec' : 'none')
   } else core.info('> No files to remove.')
 
   core.info('> Checking for uncommitted changes in the git working tree...')
@@ -41,6 +45,10 @@ core.info(`Running in ${baseDir}`)
     await git
       .addConfig('user.email', getInput('author_email'), undefined, log)
       .addConfig('user.name', getInput('author_name'), undefined, log)
+      .addConfig('author.email', getInput('author_email'), undefined, log)
+      .addConfig('author.name', getInput('author_name'), undefined, log)
+      .addConfig('committer.email', getInput('committer_email'), undefined, log)
+      .addConfig('committer.name', getInput('committer_name'), undefined, log)
     core.debug(
       '> Current git config\n' +
         JSON.stringify((await git.listConfig()).all, null, 2)
@@ -53,40 +61,38 @@ core.info(`Running in ${baseDir}`)
       .checkout(getInput('branch'), undefined, log)
       .catch(() => git.checkoutLocalBranch(getInput('branch'), log))
 
-    if (getInput('pull_strategy') == 'NO-PULL')
-      core.info('> Not pulling from repo.')
+    // The current default value is set here.
+    // When the depreacted pull_strategy input is removed, the default should be set via the action manifest.
+    const pull = getInput('pull') || getInput('pull_strategy') || '--no-rebase'
+    if (pull == 'NO-PULL') core.info('> Not pulling from repo.')
     else {
       core.info('> Pulling from remote...')
-      await git.fetch(undefined, log).pull(
-        undefined,
-        undefined,
-        {
-          [getInput('pull_strategy')]: null
-        },
-        log
-      )
+      core.debug(`Current git pull arguments: ${pull}`)
+      await git
+        .fetch(undefined, log)
+        .pull(undefined, undefined, matchGitArgs(pull), log)
     }
 
     core.info('> Re-staging files...')
-    if (getInput('add')) await add({ ignoreErrors: true })
-    if (getInput('remove')) await remove({ ignoreErrors: true })
+    if (getInput('add')) await add('all')
+    if (getInput('remove')) await remove('all')
 
     core.info('> Creating commit...')
     await git.commit(
       getInput('message'),
       undefined,
       {
-        '--author': `"${getInput('author_name')} <${getInput(
-          'author_email'
-        )}>"`,
         ...(getInput('signoff')
           ? {
               '--signoff': null
             }
           : {})
       },
-      (err, data?) => {
-        if (data) setOutput('committed', 'true')
+      (err, data?: CommitSummary) => {
+        if (data) {
+          setOutput('committed', 'true')
+          setOutput('commit_sha', data.commit)
+        }
         return log(err, data)
       }
     )
@@ -94,7 +100,7 @@ core.info(`Running in ${baseDir}`)
     if (getInput('tag')) {
       core.info('> Tagging commit...')
       await git
-        .tag(matchGitArgs(getInput('tag')), (err, data?) => {
+        .tag(matchGitArgs(getInput('tag') || ''), (err, data?) => {
           if (data) setOutput('tagged', 'true')
           return log(err, data)
         })
@@ -105,7 +111,12 @@ core.info(`Running in ${baseDir}`)
         .catch((err) => core.setFailed(err))
     } else core.info('> No tag info provided.')
 
-    const pushOption = parseBool(getInput('push')) ?? getInput('push')
+    let pushOption: string | boolean
+    try {
+      pushOption = getInput('push', true)
+    } catch {
+      pushOption = getInput('push')
+    }
     if (pushOption) {
       // If the options is `true | string`...
       core.info('> Pushing commit to repo...')
@@ -151,7 +162,7 @@ core.info(`Running in ${baseDir}`)
                 {
                   '--delete': null,
                   origin: null,
-                  [matchGitArgs(getInput('tag')).filter(
+                  [matchGitArgs(getInput('tag') || '').filter(
                     (w) => !w.startsWith('-')
                   )[0]]: null
                 },
@@ -169,6 +180,14 @@ core.info(`Running in ${baseDir}`)
     core.info('> Working tree clean. Nothing to commit.')
   }
 })()
+  .then(() => {
+    // Check for exit errors
+    if (exitErrors.length == 1) throw exitErrors[0]
+    else if (exitErrors.length > 1) {
+      exitErrors.forEach((e) => core.error(e))
+      throw 'There have been multiple runtime errors.'
+    }
+  })
   .then(logOutputs)
   .catch((e) => {
     core.endGroup()
@@ -177,11 +196,11 @@ core.info(`Running in ${baseDir}`)
   })
 
 async function checkInputs() {
-  function setInput(input: Input, value: string | undefined) {
+  function setInput(input: input, value: string | undefined) {
     if (value) return (process.env[`INPUT_${input.toUpperCase()}`] = value)
     else return delete process.env[`INPUT_${input.toUpperCase()}`]
   }
-  function setDefault(input: Input, value: string) {
+  function setDefault(input: input, value: string) {
     if (!getInput(input)) setInput(input, value)
     return getInput(input)
   }
@@ -211,7 +230,7 @@ async function checkInputs() {
     else core.setFailed('Add input: array length < 1')
   }
   if (getInput('remove')) {
-    const parsed = parseInputArray(getInput('remove'))
+    const parsed = parseInputArray(getInput('remove') || '')
     if (parsed.length == 1)
       core.info(
         'Remove input parsed as single string, running 1 git rm command.'
@@ -234,6 +253,7 @@ async function checkInputs() {
         ', '
       )}`
     )
+  // #endregion
 
   // #region author_name, author_email
   let name, email
@@ -285,6 +305,25 @@ async function checkInputs() {
   )
   // #endregion
 
+  // #region committer_name, committer_email
+  if (getInput('committer_name') || getInput('committer_email'))
+    core.info(
+      `> Using custom committer info: ${
+        getInput('committer_name') ||
+        getInput('author_name') + ' [from author info]'
+      } <${
+        getInput('committer_email') ||
+        getInput('author_email') + ' [from author info]'
+      }>`
+    )
+
+  setDefault('committer_name', getInput('author_name'))
+  setDefault('committer_email', getInput('author_email'))
+  core.debug(
+    `Committer: ${getInput('committer_name')} <${getInput('committer_email')}>`
+  )
+  // #endregion
+
   // #region message
   setDefault(
     'message',
@@ -299,9 +338,46 @@ async function checkInputs() {
     core.info(`> Running for a PR, the action will use '${branch}' as ref.`)
   // #endregion
 
+  // #region pathspec_error_handling
+  const peh_valid = ['ignore', 'exitImmediately', 'exitAtEnd']
+  if (!peh_valid.includes(getInput('pathspec_error_handling')))
+    throw new Error(
+      `"${getInput(
+        'pathspec_error_handling'
+      )}" is not a valid value for the 'pathspec_error_handling' input. Valid values are: ${peh_valid.join(
+        ', '
+      )}`
+    )
+  // #endregion
+
+  // #region pull, pull_strategy [deprecated]
+  if (getInput('pull') && getInput('pull_strategy'))
+    throw new Error(
+      "You can't use both pull and pull_strategy as action inputs. Please remove pull_strategy, which is deprecated."
+    )
+
+  if ([getInput('pull'), getInput('pull_strategy')].includes('NO-PULL'))
+    core.debug("NO-PULL found: won't pull from remote.")
+  // #endregion
+
+  // #region push
+  if (getInput('push')) {
+    // It has to be either 'true', 'false', or any other string (use as arguments)
+    let value: string | boolean
+
+    try {
+      value = getInput('push', true)
+    } catch {
+      value = getInput('push')
+    }
+
+    core.debug(`Current push option: '${value}' (parsed as ${typeof value})`)
+  }
+  // #endregion
+
   // #region signoff
   if (getInput('signoff')) {
-    const parsed = parseBool(getInput('signoff'))
+    const parsed = getInput('signoff', true)
 
     if (parsed === undefined)
       throw new Error(
@@ -320,32 +396,17 @@ async function checkInputs() {
   }
   // #endregion
 
-  // #region pull_strategy
-  if (getInput('pull_strategy') == 'NO-PULL')
-    core.debug("NO-PULL found: won't pull from remote.")
-  // #endregion
-
-  // #region push
-  if (getInput('push')) {
-    // It has to be either 'true', 'false', or any other string (use as arguments)
-    const parsed = parseBool(getInput('push'))
-
-    core.debug(
-      `Current push option: '${getInput('push')}' (parsed as ${typeof parsed})`
-    )
-  }
-  // #endregion
-
   // #region github_token
   if (!getInput('github_token'))
     core.warning(
       'No github_token has been detected, the action may fail if it needs to use the API'
     )
+  // #endregion
 }
 
-async function add({ logWarning = true, ignoreErrors = false } = {}): Promise<
-  (void | Response<void>)[]
-> {
+async function add(
+  ignoreErrors: 'all' | 'pathspec' | 'none' = 'none'
+): Promise<(void | Response<void>)[]> {
   const input = getInput('add')
   if (!input) return []
 
@@ -358,19 +419,26 @@ async function add({ logWarning = true, ignoreErrors = false } = {}): Promise<
       // If any of them fails, the whole function will return a Promise rejection
       await git
         .add(matchGitArgs(args), (err: any, data?: any) =>
-          log(ignoreErrors ? null : err, data)
+          log(ignoreErrors == 'all' ? null : err, data)
         )
         .catch((e: Error) => {
-          if (ignoreErrors) return
+          // if I should ignore every error, return
+          if (ignoreErrors == 'all') return
+
+          // if it's a pathspec error...
           if (
             e.message.includes('fatal: pathspec') &&
-            e.message.includes('did not match any files') &&
-            logWarning
-          )
-            core.warning(
-              `Add command did not match any file:\n  git add ${args}`
-            )
-          else throw e
+            e.message.includes('did not match any files')
+          ) {
+            if (ignoreErrors == 'pathspec') return
+
+            const peh = getInput('pathspec_error_handling'),
+              err = new Error(
+                `Add command did not match any file: git add ${args}`
+              )
+            if (peh == 'exitImmediately') throw err
+            if (peh == 'exitAtEnd') exitErrors.push(err)
+          } else throw e
         })
     )
   }
@@ -378,10 +446,9 @@ async function add({ logWarning = true, ignoreErrors = false } = {}): Promise<
   return res
 }
 
-async function remove({
-  logWarning = true,
-  ignoreErrors = false
-} = {}): Promise<(void | Response<void>)[]> {
+async function remove(
+  ignoreErrors: 'all' | 'pathspec' | 'none' = 'none'
+): Promise<(void | Response<void>)[]> {
   const input = getInput('remove')
   if (!input) return []
 
@@ -394,19 +461,26 @@ async function remove({
       // If any of them fails, the whole function will return a Promise rejection
       await git
         .rm(matchGitArgs(args), (e: any, d?: any) =>
-          log(ignoreErrors ? null : e, d)
+          log(ignoreErrors == 'all' ? null : e, d)
         )
         .catch((e: Error) => {
-          if (ignoreErrors) return
+          // if I should ignore every error, return
+          if (ignoreErrors == 'all') return
+
+          // if it's a pathspec error...
           if (
             e.message.includes('fatal: pathspec') &&
             e.message.includes('did not match any files')
-          )
-            logWarning &&
-              core.warning(
+          ) {
+            if (ignoreErrors == 'pathspec') return
+
+            const peh = getInput('pathspec_error_handling'),
+              err = new Error(
                 `Remove command did not match any file:\n  git rm ${args}`
               )
-          else throw e
+            if (peh == 'exitImmediately') throw err
+            if (peh == 'exitAtEnd') exitErrors.push(err)
+          } else throw e
         })
     )
   }

src/util.ts

@@ -3,25 +3,45 @@ import * as core from '@actions/core'
 import { Toolkit } from 'actions-toolkit'
 import fs from 'fs'
 
-export type Input =
-  | 'add'
-  | 'author_name'
-  | 'author_email'
-  | 'branch'
-  | 'cwd'
-  | 'default_author'
-  | 'message'
-  | 'pull_strategy'
-  | 'push'
-  | 'remove'
-  | 'signoff'
-  | 'tag'
-  | 'github_token'
+interface InputTypes {
+  add: string
+  author_name: string
+  author_email: string
+  branch: string
+  committer_name: string
+  committer_email: string
+  cwd: string
+  default_author: 'github_actor' | 'user_info' | 'github_actions'
+  message: string
+  pathspec_error_handling: 'ignore' | 'exitImmediately' | 'exitAtEnd'
+  pull: string | undefined
+  pull_strategy: string | undefined
+  push: string
+  remove: string | undefined
+  signoff: undefined
+  tag: string | undefined
 
-export type Output = 'committed' | 'pushed' | 'tagged'
+  github_token: string | undefined
+}
+export type input = keyof InputTypes
+
+interface OutputTypes {
+  committed: 'true' | 'false'
+  commit_sha: string | undefined
+  pushed: 'true' | 'false'
+  tagged: 'true' | 'false'
+}
+export type output = keyof OutputTypes
+
+export const outputs: OutputTypes = {
+  committed: 'false',
+  commit_sha: undefined,
+  pushed: 'false',
+  tagged: 'false'
+}
 
 type RecordOf<T extends string> = Record<T, string | undefined>
-export const tools = new Toolkit<RecordOf<Input>, RecordOf<Output>>({
+export const tools = new Toolkit<RecordOf<input>, RecordOf<output>>({
   secrets: [
     'GITHUB_EVENT_PATH',
     'GITHUB_EVENT_NAME',
@@ -29,14 +49,19 @@ export const tools = new Toolkit<RecordOf<Input>, RecordOf<Output>>({
     'GITHUB_ACTOR'
   ]
 })
-export const outputs: Record<Output, 'true' | 'false'> = {
-  committed: 'false',
-  pushed: 'false',
-  tagged: 'false'
-}
 
-export function getInput(name: Input) {
-  return tools.inputs[name] || ''
+export function getInput<T extends input>(name: T, parseAsBool: true): boolean
+export function getInput<T extends input>(
+  name: T,
+  parseAsBool?: false
+): InputTypes[T]
+export function getInput<T extends input>(
+  name: T,
+  parseAsBool = false
+): InputTypes[T] | boolean {
+  if (parseAsBool) return core.getBooleanInput(name)
+  // @ts-expect-error
+  return core.getInput(name)
 }
 
 export async function getUserInfo(username?: string) {
@@ -92,13 +117,6 @@ export function matchGitArgs(string: string) {
   return parsed
 }
 
-export function parseBool(value: any) {
-  try {
-    const parsed = JSON.parse(value)
-    if (typeof parsed == 'boolean') return parsed
-  } catch {}
-}
-
 export function readJSON(filePath: string) {
   let fileContent: string
   try {
@@ -114,7 +132,7 @@ export function readJSON(filePath: string) {
   }
 }
 
-export function setOutput<T extends Output>(name: T, value: typeof outputs[T]) {
+export function setOutput<T extends output>(name: T, value: OutputTypes[T]) {
   core.debug(`Setting output: ${name}=${value}`)
   outputs[name] = value
   core.setOutput(name, value)