release: v7.5.0

* fix: don't pull on new branch creation

* fix: don't show useless errors on branch creation

* feat: add branch_mode input

* fix: properly exit after fialed input check

* docs(README): document new input

.all-contributorsrc

@@ -0,0 +1,294 @@
+{
+  "projectName": "add-and-commit",
+  "projectOwner": "EndBug",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": true,
+  "commitConvention": "angular",
+  "contributors": [
+    {
+      "login": "EndBug",
+      "name": "Federico Grandi",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/26386270?v=4",
+      "profile": "https://github.com/EndBug",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "jactor-rises",
+      "name": "Tor Egil Jacobsen",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/14565088?v=4",
+      "profile": "https://github.com/jactor-rises",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "yelizariev",
+      "name": "Ivan Yelizariev",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/186131?v=4",
+      "profile": "https://twitter.com/yelizariev",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "jhhughes",
+      "name": "jhhughes",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/13724293?v=4",
+      "profile": "https://github.com/jhhughes",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "DmitrijOkeanij",
+      "name": "Дмитрий Океаний",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/10674646?v=4",
+      "profile": "https://sunengine.site",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "brahma-dev",
+      "name": "Brahma Dev",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/1793295?v=4",
+      "profile": "https://github.com/brahma-dev",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "felixlapalma",
+      "name": "Felix Rojo Lapalma",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/38389683?v=4",
+      "profile": "https://github.com/felixlapalma",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "RobinWijnant",
+      "name": "Robin Wijnant",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/33033209?v=4",
+      "profile": "http://robinwijnant.me",
+      "contributions": [
+        "bug",
+        "code"
+      ]
+    },
+    {
+      "login": "onilton",
+      "name": "Onilton Maciel",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/725676?v=4",
+      "profile": "https://github.com/onilton",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "jsoref",
+      "name": "Josh Soref",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/2119212?v=4",
+      "profile": "https://github.com/jsoref",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "ToMe25",
+      "name": "ToMe25",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/38815969?v=4",
+      "profile": "https://github.com/ToMe25",
+      "contributions": [
+        "code",
+        "ideas"
+      ]
+    },
+    {
+      "login": "JonasJacobsUserspace",
+      "name": "JonasJacobsUserspace",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/59708720?v=4",
+      "profile": "https://github.com/JonasJacobsUserspace",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "pvogt09",
+      "name": "pvogt09",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/50047961?v=4",
+      "profile": "https://github.com/pvogt09",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "connorjclark",
+      "name": "Connor Clark",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/4071474?v=4",
+      "profile": "http://hoten.cc",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "Cyberbeni",
+      "name": "Benedek Kozma",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/8356175?v=4",
+      "profile": "https://github.com/Cyberbeni",
+      "contributions": [
+        "ideas",
+        "code"
+      ]
+    },
+    {
+      "login": "coffeegoddd",
+      "name": "Dustin Brown",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/43383835?v=4",
+      "profile": "https://github.com/coffeegoddd",
+      "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"
+      ]
+    },
+    {
+      "login": "ewjoachim",
+      "name": "Joachim Jablon",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/1457576?v=4",
+      "profile": "https://github.com/ewjoachim",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "trallnag",
+      "name": "Tim Schwenke",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/24834206?v=4",
+      "profile": "https://github.com/trallnag",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "PssbleTrngle",
+      "name": "Possible Triangle",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/12880806?v=4",
+      "profile": "https://www.somethingcatchy.net",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "ocean90",
+      "name": "Dominik Schilling",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/617637?v=4",
+      "profile": "https://dominikschilling.de",
+      "contributions": [
+        "ideas",
+        "doc",
+        "code"
+      ]
+    },
+    {
+      "login": "rugk",
+      "name": "rugk",
+      "avatar_url": "https://avatars.githubusercontent.com/u/11966684?v=4",
+      "profile": "https://chaos.social/@rugk",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "xenoterracide",
+      "name": "Caleb Cushing",
+      "avatar_url": "https://avatars.githubusercontent.com/u/5517?v=4",
+      "profile": "https://xenoterracide.com",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "ruohola",
+      "name": "Eero Ruohola",
+      "avatar_url": "https://avatars.githubusercontent.com/u/33625218?v=4",
+      "profile": "https://ruohola.dev",
+      "contributions": [
+        "bug",
+        "ideas"
+      ]
+    },
+    {
+      "login": "vincentchu12",
+      "name": "Vincent Chu",
+      "avatar_url": "https://avatars.githubusercontent.com/u/23532586?v=4",
+      "profile": "https://github.com/vincentchu12",
+      "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,
+  "skipCi": true
+}

.eslintrc.js

@@ -0,0 +1,36 @@
+module.exports = {
+  env: {
+    commonjs: true,
+    es6: true,
+    node: true
+  },
+  extends: ['eslint:recommended', 'plugin:prettier/recommended'],
+  globals: {},
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 6,
+    sourceType: 'module'
+  },
+  plugins: ['@typescript-eslint'],
+  ignorePatterns: ['lib/*'],
+  rules: {
+    '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',
+      {
+        allowEmptyCatch: true
+      }
+    ],
+    'prefer-const': [
+      'warn',
+      {
+        destructuring: 'all'
+      }
+    ],
+    'spaced-comment': 'warn'
+  }
+}

.gitattributes

@@ -0,0 +1,2 @@
+* text=auto eol=lf
+lib/* linguist-generated

.github/FUNDING.yml

@@ -0,0 +1,12 @@
+# These are supported funding model platforms
+
+github: [endbug] # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
+patreon: # Replace with a single Patreon username
+open_collective: # Replace with a single Open Collective username
+ko_fi: # Replace with a single Ko-fi username
+tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
+community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
+liberapay: # Replace with a single Liberapay username
+issuehunt: # Replace with a single IssueHunt username
+otechie: # Replace with a single Otechie username
+custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

.github/ISSUE_TEMPLATE/blank-issue.md

@@ -0,0 +1,10 @@
+---
+name: Blank issue
+about: Just a blank template
+title: ''
+labels: 'status: pending'
+assignees: ''
+
+---
+
+

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,24 @@
+---
+name: Bug report
+about: Report an issue with the action
+title: ''
+labels: 'status: pending'
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is. If a particular error is shown 
+
+**Workflow used**
+Provide a snippet of the workflow and/or a link to it (use the commit sha as the ref when you link it, so that it's not influenced by other changes). If you only share a section of the workflow, make sure it includes the step that uses the action!
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Logs**
+Either provide a link to the action run or (if your repo is private) paste here the logs from the step that uses it. If you paste the logs, please use this template, and remember to paste the logs from all the different sections.
+<details>
+  <summary>Logs</summary>
+<pre><code>Your logs here.</code></pre>
+</details>

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: false

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,10 @@
+---
+name: Question
+about: Ask a question on how to use the action
+title: ''
+labels: 'type: question'
+assignees: ''
+
+---
+
+

.github/dependabot.yml

@@ -0,0 +1,16 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: 'npm' # See documentation for possible values
+    directory: '/' # Location of package manifests
+    schedule:
+      interval: 'weekly'
+    commit-message:
+      prefix: 'chore'
+      include: 'scope'
+    labels:
+      - 'type: chore'

.github/labels.yml

@@ -0,0 +1,74 @@
+- name: 'good first issue'
+  color: '5319e7'
+  description: 'Good for newcomers'
+  aliases: []
+
+- name: 'help wanted'
+  color: '008672'
+  description: 'Extra attention is needed'
+  aliases: []
+
+- name: 'status: pending'
+  color: c5def5
+  description: 'More info is needed before deciding what to do'
+  aliases: []
+
+- name: 'status: pinned'
+  color: 0052cc
+  description: 'Should not be labeled as stale'
+  aliases: []
+
+- name: 'status: stale'
+  color: fbca04
+  description: 'Inactive issues and PRs'
+  aliases: ['stale']
+
+- name: 'status: wontfix'
+  color: cfd3d7
+  description: 'This will not be worked on'
+  aliases: ['wontfix']
+
+- name: 'type: bug'
+  color: d73a4a
+  description: 'Verified problems that need to be worked on'
+  aliases: ['bug']
+
+- name: 'type: chore'
+  color: C5DEF5
+  description: 'Code changes that neither fix bugs nor add features (refactoring, dependency chnages, ...)'
+  aliases: ['dependencies', 'type: dependencies', 'automation', 'type: automation']
+
+- name: 'type: docs'
+  color: C5DEF5
+  description: "Documentation changes"
+  aliases: ['documentation', 'maintenance', 'type: maintenance']
+
+- name: 'type: duplicate'
+  color: cfd3d7
+  description: 'This issue or pull request already exists'
+  aliases: ['duplicate']
+
+- name: 'type: feature'
+  color: 0E8A16
+  description: 'New feature or feature request'
+  aliases: ['enhancement', 'type: enhancement']
+
+- name: 'type: fix'
+  color: 1D76DB
+  description: 'Updates to existing functionalities'
+  aliases: ['fix']
+
+- name: 'type: invalid'
+  color: e4e669
+  description: "This doesn't seem right"
+  aliases: ['invalid']
+
+- name: 'type: not a bug'
+  color: 0e8a16
+  description: 'Reports that happen not be our fault'
+  aliases: ['not a bug']
+
+- name: 'type: question'
+  color: d876e3
+  description: 'Further information is requested'
+  aliases: ['question']

.github/stale.yml

@@ -0,0 +1,19 @@
+# Number of days of inactivity before an issue becomes stale
+daysUntilStale: 20
+# Number of days of inactivity before a stale issue is closed
+daysUntilClose: 5
+# Issues with these labels will never be considered stale
+exemptLabels:
+  - pinned
+  - security
+  - 'status: pinned'
+  - 'type: security'
+# Label to use when marking an issue as stale
+staleLabel: 'status: stale'
+# Comment to post when marking an issue as stale. Set to `false` to disable
+markComment: >
+  This issue has been automatically marked as stale because it has not had
+  recent activity. It will be closed if no further activity occurs. Thank you
+  for your contributions.
+# Comment to post when closing a stale issue. Set to `false` to disable
+closeComment: false

.github/workflows/build.yml

@@ -0,0 +1,31 @@
+name: Build
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - src/**
+      - .github/workflows/build.yml
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build compiled JS version
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+
+      - run: npm install
+
+      - run: npm run build
+
+      - uses: EndBug/add-and-commit@v4
+        with:
+          message: '[auto] build: update compiled version'
+          add: lib
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/export-labels.yml

@@ -0,0 +1,21 @@
+name: Export label config
+on:
+  # You can run this with every event, but it's better to run it only when you actually need it.
+  workflow_dispatch:
+
+jobs:
+  labels:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: EndBug/export-label-config@main
+        with:
+          # This is needed if you're dealing with private repos.
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+          # Set this to `true` if you want to get the raw API reponse. Defaults to `false`.
+          raw-result: false
+
+          # By default every label entry will have an `aliases` property set to an empty array.
+          # It's for EndBug/label-sync, if you don't want it you cans set this to `false`
+          add-aliases: true

.github/workflows/label-sync.yml

@@ -0,0 +1,19 @@
+name: Sync labels
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - '.github/labels.yml'
+  workflow_dispatch:
+
+jobs:
+  sync:
+    name: Run EndBug/label-sync
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: EndBug/label-sync@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          config-file: '.github/labels.yml'

.github/workflows/latest.yml

@@ -1,18 +0,0 @@
-name: Add latest tag to new release
-on:
-  release:
-    types: [published]
-
-jobs: 
-  run:
-    name: Add/update tag to new release
-    runs-on: ubuntu-latest
-
-    steps: 
-    - name: Checkout repository
-      uses: actions/checkout@master
-
-    - name: Run latest-tag
-      uses: EndBug/latest-tag@latest
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,22 @@
+name: Test
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Test build
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - run: npm i
+      - run: npm run build
+
+  lint:
+    name: Check linting
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v2
+      - run: npm i
+      - run: npm run lint

.github/workflows/versioning.yml

@@ -0,0 +1,15 @@
+name: Keep the versions up-to-date
+
+on:
+  release:
+    types: [published, edited]
+
+jobs:
+  actions-tagger:
+    runs-on: windows-latest
+    steps:
+      - uses: Actions-R-Us/actions-tagger@v1
+        with:
+          publish_latest: true
+        env:
+          GITHUB_TOKEN: "${{secrets.GITHUB_TOKEN}}"

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+build

.husky/.gitignore

@@ -0,0 +1 @@
+_

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npm run build
+git add lib

.prettierrc

@@ -0,0 +1,7 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "tabWidth": 2,
+  "useTabs": false,
+  "trailingComma": "none"
+}

CHANGELOG.md

@@ -0,0 +1,312 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [7.5.0] - 2021-12-03
+
+### Added:
+
+- Support remote branch creation: use the `branch_mode` input to make the action create a new branch when there's no branch with the given name on the remote (#329)
+
+## [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:
+
+- Fixed an issue with missing outputs (#189)
+
+## [7.2.0] - 2021-04-22
+
+### Added:
+
+- `default_author`: this input allows you to control how the action fills missing author name or email (issue #167)
+- `github_token` input introduced to get token to use in API calls
+
+### Fixed:
+
+- Git args are now parsed with [`string-argv`](https://npm.im/string-argv), the format has to comply with what the package can parse (issue #179)
+
+## [7.1.2] - 2021-04-16
+
+### Fixed:
+
+- Git args parsing now correctly handles quotes, that can be used for multi-word arguments (issue #166)
+
+## [7.1.1] - 2021-04-04
+
+### Fixed:
+
+- Git args parsing has been improved, and now handles spaces correctly (issue #154)
+
+## [7.1.0] - 2021-03-03
+
+### Added:
+
+- `pull_strategy`: you can use 'NO-PULL' to prevent the action from pulling from the remote at all.
+
+## [7.0.0] - 2021-01-16
+
+### Changed:
+
+- **[BREAKING]** The token input has been removed: author info will be filled using the GitHub Actor, instead of fetching info from the GitHub API.  
+  The commits will be authored using the GitHub no-reply email associated with the account: username@users.noreply.github.com
+- **[BREAKING]** Because of the change above, the author will now be the user that triggered the action run, and not the author of the last commit: while the two are often the same person, there are instances where they might differ (e.g. when a workflow run is triggered manually).
+
+## [6.2.0] - 2020-12-23
+
+### Added:
+
+- `push` input: allow for custom `git push` arguments to be used, more info in the README. (issue #100)
+
+## [6.1.0] - 2020-12-22
+
+### Added:
+
+- `token` input: you can now use this instead of setting the `GITHUB_TOKEN` env variable, which has been deprecated. This input is optional, its default value is the default `secrets.GITHUB_TOKEN`. You only need to use this if you want the action to run with a PAT. (issue #110)
+
+### Deprecated:
+
+- `GITHUB_TOKEN`: the use of this env variable is now deprecated in favor of the `token` input, you'll start receiving warnings if you keep using it. (issue #110)
+
+## [6.0.0] - 2020-12-22
+
+### Added:
+
+- (BREAKING?) Multiple git commands: support JSON/YAML arrays for the `add` and `remove` parameters (you still need pass a string as input, but that can be parsed to an array by the action). Using them will run multiple commands in succession. I don't think this will be really breaking anything, but I've used a major version change just to be sure. There's more info about this stuff on the README. (issue #95)
+
+## [5.3.0] - 2020-12-12
+
+### Added:
+
+- Outputs: the action now has 3 outputs (`committed`, `pushed`, and `tagged`) that will be set to either `true` or `false` to tell you what the action has done. The outputs are also shown in the action logs.
+
+## [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)
+
+## [5.1.1] - 2020-11-07
+
+### Fixed:
+
+- Fixed typo in parameter name: `pull_strategy` was written as `pull_stategy` (PR #83)
+
+## [5.1.0] - 2020-10-07
+
+### Added:
+
+- The default commit message now displays the name of the workflow too (issue #64)
+
+## [5.0.0] - 2020-09-27
+
+### Changed:
+
+- **[BREAKING]** Action parameters: multiple action parameters have been changed, refer to the docs for better info
+- The code is now entirely in TypeScript (PR #57)
+
+### Fixed:
+
+- Improved input checks
+- Logs are now displayed on Windows too
+- Remove unnecessary steps
+- Remove unused dependencies
+
+## [4.4.0] - 2020-07-31
+
+### Added:
+
+- Pull requests: the action can now work in runs triggered by pull request events (issue #48)
+
+## [4.3.0] - 2020-07-29
+
+### Addded:
+
+- `signoff` parameter: lets you use the `--signoff` argument for the `git commit` command (PR #46)
+
+## [4.2.1] - 2020-07-10
+
+### Fixed:
+
+- OS-support: the action now properly works on Windows instances (issue #33)
+
+## [4.2.0] - 2020-05-17
+
+### Added:
+
+- Tagging: you can now create and update lightweight tags (PR #30)
+
+## [4.1.0] - 2020-05-01
+
+### Added:
+
+- `ref` parameter: lets you choose the branch to run the action on, the default is the one that triggered the workflow (issue #29)
+
+## [4.0.3] - 2020-05-01
+
+### Fixed:
+
+- Logs: `git diff` won't display logs anymore, to avoid buffer problems (issue #27)
+- Logs: additional info will be logged along with the command outputs
+- Logs: added groups to improve readability
+
+## [4.0.2] - 2020-04-19
+
+### Fixed:
+
+- Error handling: failures are now easier to read (issue #25)
+
+## [4.0.1] - 2020-03-20
+
+### Fixed:
+
+- Scheduled events: the action can be used in action runs triggered by a scheduled events
+- Warnings: there won't be warnings when both `author_name` and `author_email` are set
+
+## [4.0.0] - 2020-03-03
+
+### Removed:
+
+- **[BREAKING]** `path` parameter: see 'Changed' section for more info
+- **[BREAKING]** `pattern` parameter: see 'Changed' section for more info
+
+### Changed:
+
+- The action now uses `git add` and `git rm` commands, you can choose their arguemnts directly by using the `add` and `remove` parameters
+- **[BREAKING]** Error handling: the action won't stop if one of your git commands fails (e.g. if one of your pathspecs doesn't match any file)
+
+## [3.1.0] - 2020-02-21
+
+### Added:
+
+- `remove` parameter: lets you delete files directly from the action
+
+## [3.0.0] - 2020-01-24
+
+### Added:
+
+- The action can now run in multiple subsequent jobs in the same workflow
+
+### Removed:
+
+- **[BREAKING]** [`actions/checkout@v1`](https://github.com/actions/checkout/tree/v1) support is being dropped in favor of [`actions/checkout@v2`](https://github.com/actions/checkout/releases/tag/v2)
+
+## [2.3.2] - 2019-12-29
+
+### Added:
+
+- `cwd` parameter: lets you set the Current Working Directory
+
+## [2.3.1] - 2019-12-20
+
+### Added:
+
+- Short tags: from now on, there will be short major tags available (`v2`, `v3`, ...)
+
+## [2.3.0] - 2019-12-14
+
+### Changed:
+
+- TypeScript rewrite: the action will run faster because, unlike with Docker, no build process is needed
+
+### Added:
+
+- OS support: the action can now run in non-Linux environments too
+
+## [2.2.0] - 2019-12-14
+
+### Added:
+
+- The action can automatically fetch the commit author to use
+- You can manually provide the author using the `author_name` and `author_email` parameters
+
+## [2.1.1] - 2019-12-07
+
+### Fixed:
+
+- The action can now be used multiple times in the same workflow
+
+## [2.1.0] - 2019-09-19
+
+### Added:
+
+- `force` parameter: uses `--force` when running `git add`
+
+## [2.0.0] - 2019-09-18
+
+### Changed:
+
+- **[BREAKING]** The action now uses a `find` command
+
+## [1.0.0] - 2019-09-17
+
+First release
+
+#
+
+[unreleased]: https://github.com/EndBug/add-and-commit/compare/v7.5.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
+[2.1.1]: https://github.com/EndBug/add-and-commit/compare/v2.1.0...v2.1.1
+[2.2.0]: https://github.com/EndBug/add-and-commit/compare/v2.1.1...v2.2.0
+[2.3.0]: https://github.com/EndBug/add-and-commit/compare/v2.2.0...v2.3.0
+[2.3.1]: https://github.com/EndBug/add-and-commit/compare/v2.3.0...v2.3.1
+[2.3.2]: https://github.com/EndBug/add-and-commit/compare/v2.3.1...v2.3.2
+[3.0.0]: https://github.com/EndBug/add-and-commit/compare/v2.3.2...v3.0.0
+[3.1.0]: https://github.com/EndBug/add-and-commit/compare/v3.0.0...v3.1.0
+[4.0.0]: https://github.com/EndBug/add-and-commit/compare/v3.1.0...v4.0.0
+[4.0.1]: https://github.com/EndBug/add-and-commit/compare/v4.0.0...v4.0.1
+[4.0.2]: https://github.com/EndBug/add-and-commit/compare/v4.0.1...v4.0.2
+[4.0.3]: https://github.com/EndBug/add-and-commit/compare/v4.0.2...v4.0.3
+[4.1.0]: https://github.com/EndBug/add-and-commit/compare/v4.0.3...v4.1.0
+[4.2.0]: https://github.com/EndBug/add-and-commit/compare/v4.1.0...v4.2.0
+[4.2.1]: https://github.com/EndBug/add-and-commit/compare/v4.2.0...v4.2.1
+[4.3.0]: https://github.com/EndBug/add-and-commit/compare/v4.2.1...v4.3.0
+[4.4.0]: https://github.com/EndBug/add-and-commit/compare/v4.3.0...v4.4.0
+[5.0.0]: https://github.com/EndBug/add-and-commit/compare/v4.4.0...v5.0.0
+[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
+[5.3.0]: https://github.com/EndBug/add-and-commit/compare/v5.2.0...v5.3.0
+[6.0.0]: https://github.com/EndBug/add-and-commit/compare/v5.3.0...v6.0.0
+[6.1.0]: https://github.com/EndBug/add-and-commit/compare/v6.0.0...v6.1.0
+[6.2.0]: https://github.com/EndBug/add-and-commit/compare/v6.1.0...v6.2.0
+[7.0.0]: https://github.com/EndBug/add-and-commit/compare/v6.2.0...v7.0.0
+[7.1.0]: https://github.com/EndBug/add-and-commit/compare/v7.0.0...v7.1.0
+[7.1.1]: https://github.com/EndBug/add-and-commit/compare/v7.1.0...v7.1.1
+[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
+[7.5.0]: https://github.com/EndBug/add-and-commit/compare/v7.4.0...v7.5.0

Dockerfile

@@ -1,14 +0,0 @@
-FROM alpine/git:1.0.7
-
-LABEL "com.github.actions.name"="Add & Commit"
-LABEL "com.github.actions.description"="Add & commit files from a path directly from GitHub Actions"
-LABEL "com.github.actions.icon"="git-commit"
-LABEL "com.github.actions.color"="black"
-
-LABEL "repository"="https://github.com/EndBug/add-and-commit"
-LABEL "homepage"="https://github.com/EndBug/add-and-commit"
-LABEL "maintainer"="Federico Grandi <fgrandi30@gmail.com>"
-
-COPY entrypoint.sh /entrypoint.sh
-
-ENTRYPOINT ["sh", "/entrypoint.sh"]

README.md

@@ -1,100 +1,310 @@
 # Add & Commit
 
-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 and so on...
+[![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....
 
 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.
+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
-- name: Commit changes # This is the step name that will be displayed in your runs
-  uses: EndBug/add-and-commit@v2.1.1 # You can change this to use a specific version
-  with: # See more info about inputs below
-    author_name: Your Name
+- 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.
+    # Default: depends on the default_author input
+    author_name: Author Name
+
+    # 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
-    message: "Your commit message"
-    path: "."
-    pattern: "*.js"
-    force: false
-  env:
-    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Leave this line unchanged
+
+    # 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
+
+    # How the action should behave when the targeted branch is missing: "create" will create a new one on the remote, "throw" will exit
+    # Default: throw
+    branch_mode: create
+
+    # 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'
+
+    # Determines the way the action fills missing author name and email. Three options are available:
+    # - 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: github_actor
+    default_author: github_actor
+
+    # The message for the commit.
+    # Default: 'Commit from GitHub Actions (name of the workflow)'
+    message: 'Your commit message'
+
+    # 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: '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
+    push: false
+
+    # The arguments for the `git rm` command (see the paragraph below for more info)
+    # Default: ''
+    remove: './dir/old_file.js'
+
+    # Whether to use the --signoff option on `git commit` (only boolean values accepted*)
+    # Default: false
+    signoff: true
+
+    # Arguments for the git tag command (the tag name always needs to be the first word not preceded by an hyphen)
+    # Default: ''
+    tag: 'v1.0.0 --force'
 ```
 
-### Inputs:
+### Git arguments
 
-- `author_name` : the name of the user that will be displayed as the author of the commit
-- `author_email` : the email of the user that will be displayed as the author of the commit
-- `message` : the message for the commit
-- `path` : the path(s) to stage files from
-- `pattern` : the pattern that matches file names
-- `force` : whether to use the force option on git add, in order to bypass eventual gitignores
+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.
 
-### Environment variables:
+### Adding files
 
-The only `env` variable required is the token for the action to run: GitHub generates one automatically, but you need to pass it through `env` to make it available to actions. You can find more about `GITHUB_TOKEN` [here](https://help.github.com/en/articles/virtual-environments-for-github-actions#github_token-secret).  
-With that said, you can just copy the example line and don't worry about it. If you do want to use a different token you can pass that in, but I wouldn't see any possible advantage in doing so.
+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
 
-This action only **adds** files so in order to commit a file deletion you need to stage that separately: for that, you can run `git rm` in a previous step. Here's a quick example:
+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
+
+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:
+
+- `true`: this is the default value, it will behave as usual.
+- `false`: this prevents the action from pushing at all, no `git push` command is run.
+- any other string:  
+  The action will use your string as the arguments for the `git push` command. Please note that nothing is used other than your arguments, and the command will result in `git push ${push input}` (no remote, no branch, no `--set-upstream`, you have to include them yourself).
+
+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
+
+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
+
+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.
+
+The action automatically gets the GitHub token from a `github_token` input: this input should not be modified by the user, since it doesn't affect the commits as it's only used to access the GitHub API to get user info, in case they selected that option for the commit author.
+
+### About `actions/checkout`
+
+The token you use when setting up the repo with this action will determine what token `add-and-commit` will use.  
+Some users reported that they were getting an error:
+
+```
+> fatal: could not read Username for 'https://github.com': No such device or address
+```
+
+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
+
+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
+
+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"
+
+<img src="https://user-images.githubusercontent.com/26386270/115738624-80b51780-a38d-11eb-9bbe-77461654274c.png" height=40/>
 
 ```yaml
-- run: git rm delete_me.txt
-
-- uses: EndBug/add-and-commit@v2.1.1
-  with:
-    author_name: Your Name
-    author_email: mail@example.com
-    message: "Remove file"
-    path: "."
-    pattern: "*.js"  # The path is not important, the file will get removed anyway: that means you can still use the action as usual
-    force: true
-  env:
-    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+on: push
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: EndBug/add-and-commit@v7
+        with:
+          default_author: github_actions
 ```
 
-### Example:
+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:
 
-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:
+<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:
 
 ```yaml
 name: Lint source code
 on: push
 
-jobs: 
+jobs:
   run:
     name: Lint with ESLint
     runs-on: ubuntu-latest
-    steps: 
-    - name: Checkout repo
-      uses: actions/checkout@master
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
 
-    - name: Set up Node.js
-      uses: actions/setup-node@master
-      with:
-        node-version: 10.0.0
-    
-    - name: Install dependencies
-      run: npm install
+      - name: Set up Node.js
+        uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
 
-    - name: Update source code
-      run: eslint "src/**" --fix
+      - name: Install dependencies
+        run: npm install
 
-    - name: Commit changes
-      uses: EndBug/add-and-commit@v2.1.1 
-      with:
-        author_name: Your Name
-        author_email: mail@example.com
-        message: "Your commit message"
-        path: "."
-        pattern: "*.js"
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Update source code
+        run: eslint "src/**" --fix
+
+      - name: Commit changes
+        uses: EndBug/add-and-commit@v7
+        with:
+          author_name: Your Name
+          author_email: mail@example.com
+          message: 'Your commit message'
+          add: '*.js'
 ```
 
+If you need to run the action on a repository that is not located in [`$GITHUB_WORKSPACE`](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/using-environment-variables#default-environment-variables), you can use the `cwd` option: the action uses a `cd` normal command, so the path should follow bash standards.
+
+```yaml
+name: Use a different repository directory
+on: push
+
+jobs:
+  run:
+    name: Add a text file
+    runs-on: ubuntu-latest
+
+    steps:
+      # If you need to, you can check out your repo to a different location
+      - uses: actions/checkout@v2
+        with:
+          path: './pathToRepo/'
+
+      # You can make whatever type of change to the repo...
+      - run: echo "123" > ./pathToRepo/file.txt
+
+      # ...and then use the action as you would normally do, but providing the path to the repo
+      - uses: EndBug/add-and-commit@v7
+        with:
+          message: 'Add the very useful text file'
+          add: '*.txt --force'
+          cwd: './pathToRepo/'
+```
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/EndBug"><img src="https://avatars1.githubusercontent.com/u/26386270?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Federico Grandi</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/commits?author=EndBug" title="Code">💻</a> <a href="https://github.com/EndBug/add-and-commit/commits?author=EndBug" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/jactor-rises"><img src="https://avatars3.githubusercontent.com/u/14565088?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tor Egil Jacobsen</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/commits?author=jactor-rises" title="Code">💻</a></td>
+    <td align="center"><a href="https://twitter.com/yelizariev"><img src="https://avatars0.githubusercontent.com/u/186131?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Ivan Yelizariev</b></sub></a><br /><a href="#ideas-yelizariev" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/jhhughes"><img src="https://avatars2.githubusercontent.com/u/13724293?v=4?s=100" width="100px;" alt=""/><br /><sub><b>jhhughes</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3Ajhhughes" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://sunengine.site"><img src="https://avatars3.githubusercontent.com/u/10674646?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Дмитрий Океаний</b></sub></a><br /><a href="#ideas-DmitrijOkeanij" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/brahma-dev"><img src="https://avatars3.githubusercontent.com/u/1793295?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Brahma Dev</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3Abrahma-dev" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/felixlapalma"><img src="https://avatars2.githubusercontent.com/u/38389683?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Felix Rojo Lapalma</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3Afelixlapalma" title="Bug reports">🐛</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="http://robinwijnant.me"><img src="https://avatars3.githubusercontent.com/u/33033209?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Robin Wijnant</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3ARobinWijnant" title="Bug reports">🐛</a> <a href="https://github.com/EndBug/add-and-commit/commits?author=RobinWijnant" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/onilton"><img src="https://avatars2.githubusercontent.com/u/725676?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Onilton Maciel</b></sub></a><br /><a href="#ideas-onilton" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/jsoref"><img src="https://avatars0.githubusercontent.com/u/2119212?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Josh Soref</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/commits?author=jsoref" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/ToMe25"><img src="https://avatars1.githubusercontent.com/u/38815969?v=4?s=100" width="100px;" alt=""/><br /><sub><b>ToMe25</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/commits?author=ToMe25" title="Code">💻</a> <a href="#ideas-ToMe25" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/JonasJacobsUserspace"><img src="https://avatars0.githubusercontent.com/u/59708720?v=4?s=100" width="100px;" alt=""/><br /><sub><b>JonasJacobsUserspace</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3AJonasJacobsUserspace" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/pvogt09"><img src="https://avatars3.githubusercontent.com/u/50047961?v=4?s=100" width="100px;" alt=""/><br /><sub><b>pvogt09</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/commits?author=pvogt09" title="Code">💻</a></td>
+    <td align="center"><a href="http://hoten.cc"><img src="https://avatars1.githubusercontent.com/u/4071474?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Connor Clark</b></sub></a><br /><a href="#ideas-connorjclark" title="Ideas, Planning, & Feedback">🤔</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/Cyberbeni"><img src="https://avatars1.githubusercontent.com/u/8356175?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Benedek Kozma</b></sub></a><br /><a href="#ideas-Cyberbeni" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/EndBug/add-and-commit/commits?author=Cyberbeni" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/coffeegoddd"><img src="https://avatars3.githubusercontent.com/u/43383835?v=4?s=100" 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?s=100" 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?s=100" width="100px;" alt=""/><br /><sub><b>Kevin Saliou</b></sub></a><br /><a href="#ideas-kbsali" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/ewjoachim"><img src="https://avatars0.githubusercontent.com/u/1457576?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Joachim Jablon</b></sub></a><br /><a href="#ideas-ewjoachim" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/trallnag"><img src="https://avatars3.githubusercontent.com/u/24834206?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Tim Schwenke</b></sub></a><br /><a href="#ideas-trallnag" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://www.somethingcatchy.net"><img src="https://avatars1.githubusercontent.com/u/12880806?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Possible Triangle</b></sub></a><br /><a href="#ideas-PssbleTrngle" title="Ideas, Planning, & Feedback">🤔</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://dominikschilling.de"><img src="https://avatars2.githubusercontent.com/u/617637?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dominik Schilling</b></sub></a><br /><a href="#ideas-ocean90" title="Ideas, Planning, & Feedback">🤔</a> <a href="https://github.com/EndBug/add-and-commit/commits?author=ocean90" title="Documentation">📖</a> <a href="https://github.com/EndBug/add-and-commit/commits?author=ocean90" title="Code">💻</a></td>
+    <td align="center"><a href="https://chaos.social/@rugk"><img src="https://avatars.githubusercontent.com/u/11966684?v=4?s=100" width="100px;" alt=""/><br /><sub><b>rugk</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/commits?author=rugk" title="Documentation">📖</a></td>
+    <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>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
 ## License
 
 This action is distributed under the MIT license, check the [license](LICENSE) for more info.

action.yml

@@ -1,36 +1,88 @@
-name: 'Add & Commit'
-description: 'Add & commit files from a path directly from GitHub Actions'
+name: Add & Commit
+description: Add & commit files from a path directly from GitHub Actions
 
 inputs:
-  author_name:
-    description: 'The name of the user that will be displayed as the author of the commit'
-    required: true
-    default: 'Add & Commit GitHub Action'
-  author_email:
-    description: 'The email of the user that will be displayed as the author of the commit'
-    required: true
-    default: 'actions@github.com'
-  force:
-    description: 'Whether to use the force option on git add, in order to bypass eventual gitignores'
+  add:
+    description: Arguments for the git add command
     required: false
-    default: false
-  message:
-    description: 'The message for the commit'
-    required: true
-    default: 'Commit from GitHub Actions'
-  path:
-    description: 'The path to stage files from'
-    required: true
     default: '.'
-  pattern:
-    description: 'The pattern that mathces file names'
+  author_name:
+    description: The name of the user that will be displayed as the author of the commit
+    required: false
+  author_email:
+    description: The email of the user that will be displayed as the author of the commit
+    required: false
+  branch:
+    description: Name of the branch to use, if different from the one that triggered the workflow
+    required: false
+  branch_mode:
+    description: How the action should behave when the targeted branch is missing
+    required: false
+    default: throw
+  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
+    default: '.'
+  default_author:
+    description: How the action should fill missing author name or email.
+    required: false
+    default: 'github_actor'
+  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
+    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
+    default: 'true'
+  remove:
+    description: Arguments for the git rm command
+    required: false
+  signoff:
+    description: Whether to use the --signoff option on git commit
+    required: false
+  tag:
+    description: Arguments for the git tag command (the tag name always needs to be the first word not preceded by a hyphen)
     required: false
-    default: "*.*"
     
-runs:
-  using: 'docker'
-  image: 'Dockerfile'
+  # Input not required from the user
+  github_token:
+    description: The token used to make requests to the GitHub API. It's NOT used to make commits and should not be changed.
+    required: false
+    default: ${{ github.token }}
 
-branding: 
-  icon: 'git-commit'
-  color: black
+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:
+    description: Whether the action has created a tag.
+
+runs:
+  using: node12
+  main: lib/index.js
+
+branding:
+  icon: git-commit
+  color: gray-dark

entrypoint.sh

@@ -1,61 +0,0 @@
-#!/bin/sh
-set -eu
-
-# Set up .netrc file with GitHub credentials
-git_setup() {
-  cat <<- EOF > $HOME/.netrc
-        machine github.com
-        login $GITHUB_ACTOR
-        password $GITHUB_TOKEN
-
-        machine api.github.com
-        login $GITHUB_ACTOR
-        password $GITHUB_TOKEN
-EOF
-    chmod 600 $HOME/.netrc
-
-    git config --global user.email "actions@github.com"
-    git config --global user.name "Add & Commit GitHub Action"
-}
-
-add() {
-    if $INPUT_FORCE 
-    then find $INPUT_PATH -name "$INPUT_PATTERN" | while read x; do git add -f $x; done
-    else find $INPUT_PATH -name "$INPUT_PATTERN" | while read x; do git add $x; done
-    fi
-}
-
-# This is needed to make the check work for untracked files
-echo "Staging files in commit path..."
-add
-
-echo "Checking for uncommitted changes in the git working tree..."
-# This section only runs if there have been file changes
-if ! git diff --cached --exit-code
-then
-    git_setup
-
-    git fetch 
-
-    # Verify if the branch needs to be created
-    if ! git rev-parse --verify --quiet "${GITHUB_REF:11}"
-    then 
-        echo "Creating branch..."
-        git branch "${GITHUB_REF:11}"
-    fi
-
-    # Switch to branch from current workflow run
-    echo "Switching branch..."
-    git checkout "${GITHUB_REF:11}"
-
-    echo "Adding files..."
-    add
-
-    echo "Creating commit..."
-    git commit -m "$INPUT_MESSAGE" --author="$INPUT_AUTHOR_NAME <$INPUT_AUTHOR_EMAIL>"
-
-    echo "Pushing to repo..."
-    git push --set-upstream origin "${GITHUB_REF:11}"
-else
-    echo "Working tree clean. Nothing to commit."
-fi

package.json

@@ -0,0 +1,56 @@
+{
+  "name": "add-and-commit",
+  "version": "7.5.0",
+  "private": true,
+  "description": "Add & commit files from a path directly from GitHub Actions",
+  "main": "lib/index.js",
+  "scripts": {
+    "build": "ncc build src/main.ts --minify --out lib",
+    "watch": "ncc build src/main.ts --watch --out lib",
+    "lint": "eslint --ext .ts src",
+    "lint:fix": "eslint --ext .ts --fix src",
+    "changelog": "ts-node scripts/changelog.ts && npm i",
+    "prepare": "husky install",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/EndBug/add-and-commit.git"
+  },
+  "keywords": [
+    "github",
+    "action",
+    "version",
+    "npm",
+    "node"
+  ],
+  "author": "Federico Grandi <fgrandi30@gmail.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/EndBug/add-and-commit/issues"
+  },
+  "homepage": "https://github.com/EndBug/add-and-commit#readme",
+  "dependencies": {
+    "@actions/core": "^1.6.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.5",
+    "@types/node": "^12.12.54",
+    "@typescript-eslint/eslint-plugin": "^4.33.0",
+    "@typescript-eslint/parser": "^4.33.0",
+    "@vercel/ncc": "^0.32.0",
+    "all-contributors-cli": "^6.20.0",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "husky": "^7.0.4",
+    "prettier": "^2.5.0",
+    "ts-node": "^10.4.0",
+    "typescript": "^4.5.2",
+    "yamljs": "^0.3.0"
+  }
+}

scripts/changelog.ts

@@ -0,0 +1,45 @@
+import fs from 'fs'
+import path from 'path'
+
+const currentVersion = require('../package.json').version
+if (!currentVersion) throw new Error("Cant't detect library version.")
+
+const changelogPath = path.resolve(__dirname, '../CHANGELOG.md')
+const changelog = fs.readFileSync(changelogPath, { encoding: 'utf-8' })
+if (changelog.includes(`## [${currentVersion}]`))
+  throw new Error('Current version has already been documented.')
+let futureChangelog = ''
+
+// Add version section
+let arr = changelog.split('## [Unreleased]')
+arr[1] =
+  `
+
+## [${currentVersion}] - ${new Date().toISOString().slice(0, 10)}
+### Removed:
+- **[BREAKING]** ListName: description
+
+### Added:
+- 
+
+### Fixed:
+- ` + arr[1]
+futureChangelog = arr.join('## [Unreleased]')
+
+// Update footer
+arr = futureChangelog.split('\n').map((line) =>
+  line.startsWith('[unreleased]') // The link ref is lowercase because of prettier
+    ? `[unreleased]: https://github.com/EndBug/add-and-commit/compare/v${currentVersion}...HEAD`
+    : line
+)
+
+const lastVersion = ([...arr].reverse()[1]?.match(/\[([^\][]*)]/) ||
+  [])[0].replace(/[\[\]']+/g, '') // eslint-disable-line no-useless-escape
+if (!lastVersion) throw new Error("Can't find last version in changelog.")
+
+const lastLine = `[${currentVersion}]: https://github.com/EndBug/add-and-commit/compare/v${lastVersion}...v${currentVersion}`
+if (arr[arr.length - 1] === '') arr[arr.length - 1] = lastLine
+else arr.push(lastLine)
+futureChangelog = arr.join('\n')
+
+fs.writeFileSync(changelogPath, futureChangelog)

src/main.ts

@@ -0,0 +1,559 @@
+import * as core from '@actions/core'
+import path from 'path'
+import simpleGit, { CommitSummary, Response } from 'simple-git'
+import YAML from 'js-yaml'
+import {
+  getInput,
+  getUserInfo,
+  input,
+  log,
+  matchGitArgs,
+  outputs,
+  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()
+
+  core.startGroup('Internal logs')
+  core.info('> Staging files...')
+
+  const peh = getInput('pathspec_error_handling')
+
+  if (getInput('add')) {
+    core.info('> Adding files...')
+    await add(peh == 'ignore' ? 'pathspec' : 'none')
+  } else core.info('> No files to add.')
+
+  if (getInput('remove')) {
+    core.info('> Removing files...')
+    await remove(peh == 'ignore' ? 'pathspec' : 'none')
+  } else core.info('> No files to remove.')
+
+  core.info('> Checking for uncommitted changes in the git working tree...')
+  const changedFiles = (await git.diffSummary(['--cached'])).files.length
+  if (changedFiles > 0) {
+    core.info(`> Found ${changedFiles} changed files.`)
+
+    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)
+    )
+
+    await git.fetch(['--tags', '--force'], log)
+
+    core.info('> Switching/creating branch...')
+    /** This should store whether the branch already existed, of if a new one was created */
+    let branchType!: 'existing' | 'new'
+    await git
+      .checkout(getInput('branch'))
+      .then(() => (branchType = 'existing'))
+      .catch(() => {
+        if (getInput('branch_mode') == 'create') {
+          log(
+            undefined,
+            `'${getInput('branch')}' branch not found, trying to create one.`
+          )
+          branchType = 'new'
+          return git.checkoutLocalBranch(getInput('branch'), log)
+        } else throw `'${getInput('branch')}' branch not found.`
+      })
+
+    /* 
+      The current default value is set here: it will not pull when it has 
+      created a new branch, it will use --rebase when the branch already existed 
+    */
+    const pull =
+      getInput('pull') ||
+      getInput('pull_strategy') ||
+      (branchType == 'new' ? 'NO-PULL' : '--no-rebase')
+    if (pull == 'NO-PULL') core.info('> Not pulling from repo.')
+    else {
+      core.info('> Pulling from remote...')
+      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('all')
+    if (getInput('remove')) await remove('all')
+
+    core.info('> Creating commit...')
+    await git.commit(
+      getInput('message'),
+      undefined,
+      {
+        ...(getInput('signoff')
+          ? {
+              '--signoff': null
+            }
+          : {})
+      },
+      (err, data?: CommitSummary) => {
+        if (data) {
+          setOutput('committed', 'true')
+          setOutput('commit_sha', data.commit)
+        }
+        return log(err, data)
+      }
+    )
+
+    if (getInput('tag')) {
+      core.info('> Tagging commit...')
+      await git
+        .tag(matchGitArgs(getInput('tag') || ''), (err, data?) => {
+          if (data) setOutput('tagged', 'true')
+          return log(err, data)
+        })
+        .then((data) => {
+          setOutput('tagged', 'true')
+          return log(null, data)
+        })
+        .catch((err) => core.setFailed(err))
+    } else core.info('> No tag info provided.')
+
+    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...')
+
+      if (pushOption === true) {
+        core.debug(
+          `Running: git push origin ${getInput('branch')} --set-upstream`
+        )
+        await git.push(
+          'origin',
+          getInput('branch'),
+          { '--set-upstream': null },
+          (err, data?) => {
+            if (data) setOutput('pushed', 'true')
+            return log(err, data)
+          }
+        )
+      } else {
+        core.debug(`Running: git push ${pushOption}`)
+        await git.push(
+          undefined,
+          undefined,
+          matchGitArgs(pushOption),
+          (err, data?) => {
+            if (data) setOutput('pushed', 'true')
+            return log(err, data)
+          }
+        )
+      }
+
+      if (getInput('tag')) {
+        core.info('> Pushing tags to repo...')
+        await git
+          .pushTags('origin', undefined, (e, d?) => log(undefined, e || d))
+          .catch(() => {
+            core.info(
+              '> Tag push failed: deleting remote tag and re-pushing...'
+            )
+            return git
+              .push(
+                undefined,
+                undefined,
+                {
+                  '--delete': null,
+                  origin: null,
+                  [matchGitArgs(getInput('tag') || '').filter(
+                    (w) => !w.startsWith('-')
+                  )[0]]: null
+                },
+                log
+              )
+              .pushTags('origin', undefined, log)
+          })
+      } else core.info('> No tags to push.')
+    } else core.info('> Not pushing anything.')
+
+    core.endGroup()
+    core.info('> Task completed.')
+  } else {
+    core.endGroup()
+    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()
+    logOutputs()
+    core.setFailed(e)
+  })
+
+async function checkInputs() {
+  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) {
+    if (!getInput(input)) setInput(input, value)
+    return getInput(input)
+  }
+
+  const eventPath = process.env.GITHUB_EVENT_PATH,
+    event = eventPath && readJSON(eventPath)
+
+  const isPR = process.env.GITHUB_EVENT_NAME?.includes('pull_request'),
+    defaultBranch = isPR
+      ? (event?.pull_request?.head?.ref as string)
+      : process.env.GITHUB_REF?.substring(11)
+
+  // #region add, remove
+  if (!getInput('add') && !getInput('remove'))
+    throw new Error(
+      "Both 'add' and 'remove' are empty, the action has nothing to do."
+    )
+
+  if (getInput('add')) {
+    const parsed = parseInputArray(getInput('add'))
+    if (parsed.length == 1)
+      core.info('Add input parsed as single string, running 1 git add command.')
+    else if (parsed.length > 1)
+      core.info(
+        `Add input parsed as string array, running ${parsed.length} git add commands.`
+      )
+    else core.setFailed('Add input: array length < 1')
+  }
+  if (getInput('remove')) {
+    const parsed = parseInputArray(getInput('remove') || '')
+    if (parsed.length == 1)
+      core.info(
+        'Remove input parsed as single string, running 1 git rm command.'
+      )
+    else if (parsed.length > 1)
+      core.info(
+        `Remove input parsed as string array, running ${parsed.length} git rm commands.`
+      )
+    else core.setFailed('Remove input: array length < 1')
+  }
+  // #endregion
+
+  // #region default_author
+  const default_author_valid = ['github_actor', 'user_info', 'github_actions']
+  if (!default_author_valid.includes(getInput('default_author')))
+    throw new Error(
+      `'${getInput(
+        'default_author'
+      )}' is not a valid value for default_author. Valid values: ${default_author_valid.join(
+        ', '
+      )}`
+    )
+  // #endregion
+
+  // #region author_name, author_email
+  let name, email
+  switch (getInput('default_author')) {
+    case 'github_actor': {
+      name = process.env.GITHUB_ACTOR
+      email = `${process.env.GITHUB_ACTOR}@users.noreply.github.com`
+      break
+    }
+
+    case 'user_info': {
+      if (!getInput('author_name') || !getInput('author_email')) {
+        const res = await getUserInfo(process.env.GITHUB_ACTOR)
+        if (!res?.name)
+          core.warning("Couldn't fetch author name, filling with github_actor.")
+        if (!res?.email)
+          core.warning(
+            "Couldn't fetch author email, filling with github_actor."
+          )
+
+        res?.name && (name = res?.name)
+        res?.email && (email = res.email)
+        if (name && email) break
+      }
+
+      !name && (name = process.env.GITHUB_ACTOR)
+      !email && (email = `${process.env.GITHUB_ACTOR}@users.noreply.github.com`)
+      break
+    }
+
+    case 'github_actions': {
+      name = 'github-actions'
+      email = '41898282+github-actions[bot]@users.noreply.github.com'
+      break
+    }
+
+    default:
+      throw new Error(
+        'This should not happen, please contact the author of this action. (checkInputs.author)'
+      )
+  }
+
+  setDefault('author_name', name)
+  setDefault('author_email', email)
+  core.info(
+    `> Using '${getInput('author_name')} <${getInput(
+      'author_email'
+    )}>' as author.`
+  )
+  // #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',
+    `Commit from GitHub Actions (${process.env.GITHUB_WORKFLOW})`
+  )
+  core.info(`> Using "${getInput('message')}" as commit message.`)
+  // #endregion
+
+  // #region branch
+  const branch = setDefault('branch', defaultBranch || '')
+  if (isPR)
+    core.info(`> Running for a PR, the action will use '${branch}' as ref.`)
+  // #endregion
+
+  // #region branch_mode
+  const branch_mode_valid = ['throw', 'create']
+  if (!branch_mode_valid.includes(getInput('branch_mode')))
+    throw new Error(
+      `"${getInput(
+        'branch_mode'
+      )}" is not a valid value for the 'branch_mode' input. Valid values are: ${branch_mode_valid.join(
+        ', '
+      )}`
+    )
+  // #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 = getInput('signoff', true)
+
+    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)
+
+    core.debug(
+      `Current signoff option: ${getInput('signoff')} (${typeof getInput(
+        'signoff'
+      )})`
+    )
+  }
+  // #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(
+  ignoreErrors: 'all' | 'pathspec' | 'none' = 'none'
+): Promise<(void | Response<void>)[]> {
+  const input = getInput('add')
+  if (!input) return []
+
+  const parsed = parseInputArray(input)
+  const res: (void | Response<void>)[] = []
+
+  for (const args of parsed) {
+    res.push(
+      // Push the result of every git command (which are executed in order) to the array
+      // If any of them fails, the whole function will return a Promise rejection
+      await git
+        .add(matchGitArgs(args), (err: any, data?: any) =>
+          log(ignoreErrors == 'all' ? null : err, data)
+        )
+        .catch((e: Error) => {
+          // 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')
+          ) {
+            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
+        })
+    )
+  }
+
+  return res
+}
+
+async function remove(
+  ignoreErrors: 'all' | 'pathspec' | 'none' = 'none'
+): Promise<(void | Response<void>)[]> {
+  const input = getInput('remove')
+  if (!input) return []
+
+  const parsed = parseInputArray(input)
+  const res: (void | Response<void>)[] = []
+
+  for (const args of parsed) {
+    res.push(
+      // Push the result of every git command (which are executed in order) to the array
+      // If any of them fails, the whole function will return a Promise rejection
+      await git
+        .rm(matchGitArgs(args), (e: any, d?: any) =>
+          log(ignoreErrors == 'all' ? null : e, d)
+        )
+        .catch((e: Error) => {
+          // 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')
+          ) {
+            if (ignoreErrors == 'pathspec') return
+
+            const peh = getInput('pathspec_error_handling'),
+              err = new Error(
+                `Remove command did not match any file:\n  git rm ${args}`
+              )
+            if (peh == 'exitImmediately') throw err
+            if (peh == 'exitAtEnd') exitErrors.push(err)
+          } else throw e
+        })
+    )
+  }
+
+  return res
+}
+
+/**
+ * Tries to parse a JSON array, then a YAML array.
+ * If both fail, it returns an array containing the input value as its only element
+ */
+function parseInputArray(input: string): string[] {
+  try {
+    const json = JSON.parse(input)
+    if (
+      json &&
+      Array.isArray(json) &&
+      json.every((e) => typeof e == 'string')
+    ) {
+      core.debug(`Input parsed as JSON array of length ${json.length}`)
+      return json
+    }
+  } catch {}
+
+  try {
+    const yaml = YAML.load(input)
+    if (
+      yaml &&
+      Array.isArray(yaml) &&
+      yaml.every((e) => typeof e == 'string')
+    ) {
+      core.debug(`Input parsed as YAML array of length ${yaml.length}`)
+      return yaml
+    }
+  } catch {}
+
+  core.debug('Input parsed as single string')
+  return [input]
+}
+
+function logOutputs() {
+  core.startGroup('Outputs')
+  for (const key in outputs) {
+    core.info(`${key}: ${outputs[key]}`)
+  }
+  core.endGroup()
+}

src/util.ts

@@ -0,0 +1,143 @@
+import { parseArgsStringToArgv } from 'string-argv'
+import * as core from '@actions/core'
+import { Toolkit } from 'actions-toolkit'
+import fs from 'fs'
+
+interface InputTypes {
+  add: string
+  author_name: string
+  author_email: string
+  branch: string
+  branch_mode: 'throw' | 'create'
+  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
+
+  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>>({
+  secrets: [
+    'GITHUB_EVENT_PATH',
+    'GITHUB_EVENT_NAME',
+    'GITHUB_REF',
+    'GITHUB_ACTOR'
+  ]
+})
+
+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) {
+  if (!username) return undefined
+
+  const res = await tools.github.users.getByUsername({ username })
+
+  core.debug(
+    `Fetched github actor from the API: ${JSON.stringify(res?.data, null, 2)}`
+  )
+
+  return {
+    name: res?.data?.name,
+    email: res?.data?.email
+  }
+}
+
+export function log(err: any | Error, data?: any) {
+  if (data) console.log(data)
+  if (err) core.error(err)
+}
+
+/**
+ * Matches the given string to an array of arguments.  
+ * The parsing is made by `string-argv`: if your way of using argument is not supported, the issue is theirs!
+ * {@link https://www.npm.im/string-argv}
+ * @example
+ * ```js
+ * matchGitArgs(`
+    -s
+    --longOption 'This uses the "other" quotes'
+    --foo 1234
+    --file=message.txt
+    --file2="Application 'Support'/\"message\".txt"
+  `) => [
+    '-s',
+    '--longOption',
+    'This uses the "other" quotes',
+    '--foo',
+    '1234',
+    '--file=message.txt',
+    `--file2="Application 'Support'/\\"message\\".txt"`
+  ]
+ * matchGitArgs('      ') => [ ]
+ * ```
+ * @returns An array, if there's no match it'll be empty
+ */
+export function matchGitArgs(string: string) {
+  const parsed = parseArgsStringToArgv(string)
+  core.debug(`Git args parsed:
+  - Original: ${string}
+  - Parsed: ${JSON.stringify(parsed)}`)
+  return parsed
+}
+
+export function readJSON(filePath: string) {
+  let fileContent: string
+  try {
+    fileContent = fs.readFileSync(filePath, { encoding: 'utf8' })
+  } catch {
+    throw `Couldn't read file. File path: ${filePath}`
+  }
+
+  try {
+    return JSON.parse(fileContent)
+  } catch {
+    throw `Couldn't parse file to JSON. File path: ${filePath}`
+  }
+}
+
+export function setOutput<T extends output>(name: T, value: OutputTypes[T]) {
+  core.debug(`Setting output: ${name}=${value}`)
+  outputs[name] = value
+  core.setOutput(name, value)
+}
+
+// Setup default output values
+Object.entries(outputs).forEach(([name, value]) => core.setOutput(name, value))

tsconfig.json

@@ -0,0 +1,62 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    // "incremental": true,                   /* Enable incremental compilation */
+    "target": "es6", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */
+    "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    "outDir": "./build", /* Redirect output structure to the directory. */
+    "rootDir": "./src", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+    /* Strict Type-Checking Options */
+    "strict": true, /* Enable all strict type-checking options. */
+    "noImplicitAny": false, /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+    /* Module Resolution Options */
+    "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+    // "allowUmdGlobalAccess": true,          /* Allow accessing UMD globals from modules. */
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+  },
+  "exclude": [
+    "node_modules",
+    "**/*.test.ts",
+    "scripts"
+  ]
+}