9.1.0

* docs: update README.md [skip ci]

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

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

.all-contributorsrc

@@ -138,6 +138,291 @@
       "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"
+      ]
+    },
+    {
+      "login": "drewwells",
+      "name": "Drew Wells",
+      "avatar_url": "https://avatars.githubusercontent.com/u/239123?v=4",
+      "profile": "http://blog.madewithdrew.com/",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "JavierSegoviaCordoba",
+      "name": "Javier Segovia Córdoba",
+      "avatar_url": "https://avatars.githubusercontent.com/u/7463564?v=4",
+      "profile": "https://kotlin.desarrollador-android.com/",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "Darylgolden",
+      "name": "Darylgolden",
+      "avatar_url": "https://avatars.githubusercontent.com/u/9102529?v=4",
+      "profile": "https://github.com/Darylgolden",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "mcargille",
+      "name": "mcargille",
+      "avatar_url": "https://avatars.githubusercontent.com/u/20142895?v=4",
+      "profile": "https://github.com/mcargille",
+      "contributions": [
+        "bug",
+        "code"
+      ]
+    },
+    {
+      "login": "secondmanveran",
+      "name": "secondman",
+      "avatar_url": "https://avatars.githubusercontent.com/u/97000801?v=4",
+      "profile": "https://github.com/secondmanveran",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "prince-chrismc",
+      "name": "Chris Mc",
+      "avatar_url": "https://avatars.githubusercontent.com/u/16867443?v=4",
+      "profile": "https://github.com/prince-chrismc",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "Namyalg",
+      "name": "Namya LG",
+      "avatar_url": "https://avatars.githubusercontent.com/u/53875297?v=4",
+      "profile": "https://linkedin.com/in/namyalg",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "sconix",
+      "name": "Janne Julkunen",
+      "avatar_url": "https://avatars.githubusercontent.com/u/921515?v=4",
+      "profile": "https://github.com/sconix",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "Josh-Cena",
+      "name": "Joshua Chen",
+      "avatar_url": "https://avatars.githubusercontent.com/u/55398995?v=4",
+      "profile": "https://joshcena.com",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "Akimon658",
+      "name": "Akimo",
+      "avatar_url": "https://avatars.githubusercontent.com/u/81888693?v=4",
+      "profile": "http://akimon658.github.io",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "revolunet",
+      "name": "Julien Bouquillon",
+      "avatar_url": "https://avatars.githubusercontent.com/u/124937?v=4",
+      "profile": "https://revolunet.com",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "AvivPeledTalon",
+      "name": "Aviv Peled",
+      "avatar_url": "https://avatars.githubusercontent.com/u/92471076?v=4",
+      "profile": "https://github.com/AvivPeledTalon",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "onedr0p",
+      "name": "Devin Buhl",
+      "avatar_url": "https://avatars.githubusercontent.com/u/213795?v=4",
+      "profile": "https://github.com/onedr0p",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "melink14",
+      "name": "Erek Speed",
+      "avatar_url": "https://avatars.githubusercontent.com/u/1176550?v=4",
+      "profile": "https://erekspeed.com",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "kachkaev",
+      "name": "Alexander Kachkaev",
+      "avatar_url": "https://avatars.githubusercontent.com/u/608862?v=4",
+      "profile": "https://kachkaev.uk",
+      "contributions": [
+        "bug"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.eslintrc

@@ -1,63 +0,0 @@
-{
-  "env": {
-    "node": true,
-    "browser": true,
-    "amd": true,
-    "es6": true
-  },
-  "root": true,
-  "extends": [
-    "eslint:recommended"
-  ],
-  "plugins": [
-    "@typescript-eslint"
-  ],
-  "parser": "@typescript-eslint/parser",
-  "parserOptions": {
-    "ecmaVersion": 6,
-    "sourceType": "module",
-    "ecmaFeatures": {
-      "jsx": true
-    }
-  },
-  "rules": {
-    "no-cond-assign": [
-      2,
-      "except-parens"
-    ],
-    "no-use-before-define": [
-      2,
-      {
-        "functions": false,
-        "classes": false,
-        "variables": false
-      }
-    ],
-    "new-cap": 0,
-    "no-caller": 2,
-    "no-undef": 2,
-    "no-unused-vars": 1,
-    "no-empty": [
-      "error",
-      {
-        "allowEmptyCatch": true
-      }
-    ],
-    "no-console": "off",
-    "prefer-const": [
-      "warn",
-      {
-        "destructuring": "all"
-      }
-    ],
-    "quotes": [
-      "warn",
-      "single"
-    ],
-    "semi": [
-      "warn",
-      "never"
-    ],
-    "spaced-comment": "warn"
-  }
-}

.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,26 @@
+# 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'
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10
+    commit-message:
+      include: scope
+      prefix: ci
+    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

@@ -1,36 +0,0 @@
-name: Build
-on:
-  push:
-    branches-ignore:
-      - dist
-    paths:
-      - src/**
-      - .github/workflows/build.yml
-
-jobs:
-  build:
-    name: Build compiled JS version
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v2
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v1
-        with:
-          node-version: 12.x
-
-      - name: Install dependencies
-        run: npm install
-
-      - name: Compile TypeScript into compressed JavaScript
-        run: npm run build
-
-      - name: Commit changes
-        uses: EndBug/add-and-commit@v4.0.0
-        with:
-          message: "[auto] build: update compiled version"
-          add: lib
-          force: true
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,60 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ main ]
+  schedule:
+    - cron: '40 12 * * 2'
+
+jobs:
+  analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        # Override language selection by uncommenting this and choosing your languages
+        # with:
+        #   languages: go, javascript, csharp, python, cpp, java
+
+      # Autobuild attempts to build any compiled languages (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below).
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following
+      #    three lines and modify them (or add more) to build your code if your
+      #    project uses a compiled language
+
+      #- run: |
+      #     make bootstrap
+      #     make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

.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,18 @@
+name: Sync labels
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - '.github/labels.yml'
+  workflow_dispatch:
+
+jobs:
+  sync:
+    name: Run EndBug/label-sync
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: EndBug/label-sync@v2
+        with:
+          config-file: '.github/labels.yml'

.github/workflows/test.yml

@@ -0,0 +1,28 @@
+name: Test
+on:
+  push:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          cache: npm
+      - run: npm ci
+      - run: npm run build
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          cache: npm
+      - run: npm ci
+      - run: npm run lint

.github/workflows/versioning.yml

@@ -1,4 +1,4 @@
-name: Keep the versions up-to-date
+name: Update tags
 
 on:
   release:
@@ -6,10 +6,8 @@ on:
 
 jobs:
   actions-tagger:
-    runs-on: windows-latest
+    runs-on: windows-2022
     steps:
-      - uses: Actions-R-Us/actions-tagger@v1
+      - uses: Actions-R-Us/actions-tagger@v2
         with:
-          publish_latest: true
-        env:
-          GITHUB_TOKEN: "${{secrets.GITHUB_TOKEN}}"
+          publish_latest_tag: true

.gitignore

@@ -1,3 +1,2 @@
 node_modules
 build
-lib

.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,371 @@
+# 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]
+
+## [9.1.0] - 2022-08-22
+### Added:
+- The `fetch` input allows you to customize the `git fetch` command, or to prevent the action from fetching at all.
+
+## [9.0.1] - 2022-06-26
+### Fixed:
+- Now files are re-staged after pulling, so that the action works as intended when using options such as `pull: --rebase --autostash`
+
+## [9.0.0] - 2022-03-11
+
+### Changed:
+
+- **[BREAKING]** The action will now fail when the `git commit` command fails. (#370)
+- **[BREAKING]** The action won't try deleting and re-creting tags when it fails to push them, it's now up to you to set the proper arguments (see the `tag_push` input). (#367)
+
+### Added:
+
+- `tag_push` input: you can now set the arguments of the `git push --tags` command.
+- `tag_pushed` output: whether the action pushed tags.
+
+## [8.0.2] - 2022-02-07
+
+### Fixed:
+
+- The `commit` input is now properly listed in the README. (#360)
+
+## [8.0.1] - 2022-01-23
+
+### Fixed:
+
+- Fixed a bug that prevented the `--allow-empty` flag from being used for the `commit` input. (#352)
+- Fixed README and CHANGELOG docs for the `pull` input, that were still showing the option to use `NO-PULL` to prevent pulling (while now it's the default behavior). (#354)
+- Added a paragraph to the FAQs section of the README, that explains how to work with PRs in v8. (#351)
+
+## [8.0.0] - 2022-01-20
+
+### Fixed:
+
+- **[BREAKING]** The action will now work with whatever ref has been checked out, without pulling or switching branches by default. You can still pull using the `pull` input and create a new branch with the newly-added `new_branch` input. For more info, check commit [`6fdb34e`](https://github.com/EndBug/add-and-commit/commit/6fdb34ed01d242c909eeb7e31bf1c4d37db43a54).
+
+### Removed:
+
+- **[BREAKING]** The `signoff` input has been removed, use `commit` instead. (#331)
+- **[BREAKING]** The `pull_strategy` input has been removed, use `pull` instead.
+- **[BREAKING]** The `branch` and `branch_mode` inputs have been removed, check commit [`6fdb34e`](https://github.com/EndBug/add-and-commit/commit/6fdb34ed01d242c909eeb7e31bf1c4d37db43a54) for more info.
+- **[BREAKING]** The `pull` input doesn't support `NO-PULL` anymore: if you don't want the action to pull, simply remove the input, as it's the default behavior now.
+
+### Added:
+
+- Added the `commit` input, that allows you to change the arguments for the `git commit` command. (#331)
+- Added the `new_branch` input. ([`6fdb34e`](https://github.com/EndBug/add-and-commit/commit/6fdb34ed01d242c909eeb7e31bf1c4d37db43a54))
+- Added the `commit_long_sha` output. (#349)
+
+## [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/v9.1.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
+[8.0.0]: https://github.com/EndBug/add-and-commit/compare/v7.5.0...v8.0.0
+[8.0.1]: https://github.com/EndBug/add-and-commit/compare/v8.0.0...v8.0.1
+[8.0.2]: https://github.com/EndBug/add-and-commit/compare/v8.0.1...v8.0.2
+[9.0.0]: https://github.com/EndBug/add-and-commit/compare/v8.0.2...v9.0.0
+[9.0.1]: https://github.com/EndBug/add-and-commit/compare/v9.0.0...v9.0.1
+[9.1.0]: https://github.com/EndBug/add-and-commit/compare/v9.0.1...v9.1.0

README.md

@@ -1,86 +1,260 @@
 # Add & Commit
-<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors-)
-<!-- ALL-CONTRIBUTORS-BADGE:END -->
 
-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....
+[![All Contributors](https://img.shields.io/github/all-contributors/EndBug/add-and-commit)](#contributors-)
 
-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.
+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...
 
-## Usage
+## Table of contents
+
+- [Inputs](#inputs)
+- [Outputs](#outputs)
+- [FAQs](#faqs)
+- [Examples](#examples)
+- [Contributors](#contributors-)
+
+## Inputs
 
 Add a step like this to your workflow:
 
 ```yaml
-- uses: EndBug/add-and-commit@v4 # You can change this to use a specific version
+- uses: EndBug/add-and-commit@v9 # 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: author of the commit that triggered the run
-    author_name: Your Name
+    # 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: author of the commit that triggered the run
+    # 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
 
-    # The local path to the directory where your repository is located. You should use actions/checkout first to set it up
+    # Additional arguments for the git commit command. The --message argument is already set by the message input.
+    # Default: ''
+    commit: --signoff
+
+    # 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'
 
-    # Whether to use the --force option on `git add`, in order to bypass eventual gitignores
-    # Default: false
-    force: true
+    # 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
 
-    # Whether to use the --signoff option on `git commit`
-    # Default: false
-    signoff: true
+    # Arguments for the git fetch command. If set to false, the action won't fetch the repo.
+    # For more info as to why fetching is usually recommended, please see the "Performance on large repos" FAQ. 
+    # Default: --tags --force
+    fetch: false
 
-    # The message for the commit
-    # Default: 'Commit from GitHub Actions'
+    # The message for the commit.
+    # Default: 'Commit from GitHub Actions (name of the workflow)'
     message: 'Your commit message'
 
-    # Name of the branch to use, if different from the one that triggered the workflow
-    # Default: the branch that triggered the workflow (from GITHUB_REF)
-    ref: 'someOtherBranch'
+    # If this input is set, the action will push the commit to a new branch with this name.
+    # Default: ''
+    new_branch: custom-new-branch
+
+    # 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. By default, the action does not pull.
+    # Default: ''
+    pull: '--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"
+    remove: './dir/old_file.js'
 
-    # Name of the tag to add to the new commit (see the paragraph below for more info)
+    # 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"
+    tag: 'v1.0.0 --force'
 
-  env:
-    # This is necessary in order to push a commit to the repo
-    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Leave this line unchanged
+    # Arguments for the git push --tags command (any additional argument will be added after --tags)
+    # Default: ''
+    tag_push: '--force'
 ```
 
-### Environment variables:
+### Git arguments
 
-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).  
-That said, you can just copy the example line and not 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.
+Multiple options let you provide the git arguments that you want the action to use. It's important to note that these arguments **are not actually used with a CLI command**, but they are parsed by a package called [`string-argv`](https://npm.im/string-argv), and then used with [`simple-git`](https://npm.im/simple-git).  
+What does this mean for you? It means that string that contain a lot of nested quotes may be parsed incorrectly, and that specific ways of declaring arguments may not be supported by this libraries. If you're having issues with your argument strings you can check whether they're being parsed correctly either by [enabling debug logging](https://docs.github.com/en/actions/managing-workflow-runs/enabling-debug-logging) for your workflow runs or by testing it directly with `string-argv` ([RunKit demo](https://npm.runkit.com/string-argv)): if each argument and option is aprsed correctly you'll see an array where every string is an option or value.
 
-### Adding files:
+### Adding files
 
-The action adds files using a regular `git add` command, so you can put every kind of argument in the `add` option. For example, if you don't want it to use a recursive behavior: `$(find . -maxdepth 1 -name *.js)`.
-The script will not stop if one of the git commands fails. E.g.: if your command shows a "fatal: pathspec 'yourFile' did not match any files" error the action will go on.
+The action adds files using a regular `git add` command, so you can put every kind of argument in the `add` option. For example, if you want to force-add a file: `./path/to/file.txt --force`.  
+The script will not stop if one of the git commands doesn't match any file. E.g.: if your command shows a "fatal: pathspec 'yourFile' did not match any files" error the action will go on.  
+You can also use JSON or YAML arrays (e.g. `'["first", "second"]'`, `"['first', 'second']"`) to make the action run multiple `git add` commands: the action will log how your input has been parsed. Please mind that your input still needs to be a string because of how GitHub Actions works with inputs: just write your array inside the string, the action will parse it later.
 
-### Deleting files:
+### Deleting files
 
-You can delete files with the `remove` option: that runs a `git rm` command that will stage the files in the given path for removal. 
-The script will not stop if one of the git commands fails. E.g.: if your command shows a "fatal: pathspec 'yourFile' did not match any files" error the action will go on.
+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.
 
-### Tagging:
+### Pushing
 
-You can tag commits with the `tag` option: when used, it will create a lightweight tag for the commit with the name you set as input. If not entered (or if an empty string is passed) teh action won't create any tag.  
-If there is already a tag with the name you entered it will be overwritten, and so the tag will be "updated".
+By default the action runs the following command: `git push origin ${new_branch input} --set-upstream`. You can use the `push` input to modify this behavior, here's what you can set it to:
 
-### Examples:
+- `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`.
+
+### Creating a new branch
+
+If you want the action to commit in a new branch, you can use the `new_branch` input.
+
+Please note that if the branch exists, the action will still try push to it, but it's possible that the push will be rejected by the remote as non-straightforward.
+
+If that's the case, you need to make sure that the branch you want to commit to is already checked out before you run the action.  
+If you're **really** sure that you want to commit to that branch, you can also force-push by setting the `push` input to something like `origin yourBranchName --set-upstream --force`.
+
+If you want to commit files "across different branches", here are two ways to do it:
+
+1. You can check them out in two different directories, generate your files, move them to your destination and then run `add-and-commit` in the destination directory using the `cwd` input.
+2. You can manually commit those files with `git` commands as you would on your machine. There are several ways to do this depending on the scenario. One of them if to stash your changes, checkout the destination branch, and popping the stash. You can then use the `add-and-commit` action as usual. Please note that this is just an example and may not work for you, since your use case may be different.
+
+### 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).  
+You can also change the arguments of the push command for tags: every argument in the `tag_push` input will be appended to the `git push --tags` command.  
+For more info on how git arguments are parsed, see [the "Git arguments" section](#git-arguments).
+
+## Outputs
+
+The action provides these outputs:
+
+- `committed`: whether the action has created a commit (`'true'` or `'false'`)
+- `commit_long_sha`: the full SHA of the commit that has just been created
+- `commit_sha`: the short 7-character 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'`)
+- `tag_pushed`: whether the action has pushed 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).
+
+## FAQs
+
+### Working with PRs
+
+By default, when you use `actions/checkout` on a PR, it will checkout the head commit in a detached head state.
+If you want to make some changes, you have to checkout the branch the PR is coming from in the head repo.  
+You can set it up like this:
+
+```yaml
+- uses: actions/checkout@v2
+  with:
+    repository: ${{ github.event.pull_request.head.repo.full_name }}
+    ref: ${{ github.event.pull_request.head.ref }}
+```
+
+You can find the full docs for payloads of `pull_request` events [here](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#webhook-payload-example-32).
+
+If you're planning on running this only on "internal" PRs (where head and base are in the same repo) then you can omit the `repository` input.  
+If you're planning to use this with PRs coming from other forks, please keep in mind that you might not have write access to those repos.
+You can try setting up the repo with your PAT, as explained in the ["About tokens" paragraph](#about-tokens) of this section.
+
+Keep in mind that this "custom checkout" is meant only for PRs: if your workflow runs on multiple events (like `push` or `workflow_dispatch`), you could try having this step run only for `pull_request` events, while other ones will trigger the usual checkout.  
+If you wish to do so, you can use the `step.if` property, [here](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsif)'s the docs.
+
+### About 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.
+
+### The commit from the action is not triggering CI!
+
+That's because you're checking out the repo using the built-in [`GITHUB_TOKEN` secret](https://docs.github.com/en/actions/security-guides/automatic-token-authentication): GitHub sees that the push event has been triggered by a commit generated by CI, and doesn't run any further checks to avoid unintentional check loops.
+
+**If you're sure** that you want the commits generated during CI to trigger other workflow runs, you can checkout the repo using a [Personal Access Token (PAT)](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token): this will make the resulting commit the same as if you made it yourself.  
+If you're using `actions/checkout`, check out their [docs](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token) to see how to set your repo token.
+
+### 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)
+
+### Performance on large repos
+
+By default, the action will fetch the repository before starting to work on it: this ensures that it can see the already existing refs.  
+
+When working with a repository that has a lot of branches and tags, fetching it can take a long time. If the fetch step is taking too much time, you can decide to skip it by setting the `fetch` input to `false`: this will prevent the action from running `git fetch` altogether. 
+
+Please note that you have to set up your workflow accordingly: not fetching the repo can impact branch and tag creation within the action, and for this reason it's recommended to disable it only if necessary. Issue ref: [#386](https://github.com/EndBug/add-and-commit/issues/386)
+
+## Examples
+
+### Different author/committer configurations
+
+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
+on: push
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: EndBug/add-and-commit@v9
+        with:
+          default_author: github_actions
+```
+
+You can also use the `committer_name` and `committer_email` inputs to make it appear as if GitHub Actions is the committer, here are a couple of example steps:
+
+<img src="https://user-images.githubusercontent.com/26386270/130594168-1d910710-e2d0-4b06-9324-cbe5dde59154.png" height=70/>
+
+```yaml
+- uses: EndBug/add-and-commit@v9
+  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@v9
+  with:
+    message: Show GitHub logo
+    committer_name: GitHub Actions
+    committer_email: 41898282+github-actions[bot]@users.noreply.github.com
+```
+
+### Automated linting
 
 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:
 
@@ -88,43 +262,43 @@ Do you want to lint your JavaScript files, located in the `src` folder, with ESL
 name: Lint source code
 on: push
 
-jobs: 
+jobs:
   run:
     name: Lint with ESLint
     runs-on: ubuntu-latest
-    steps: 
-    - name: Checkout repo
-      uses: actions/checkout@v2
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v2
 
-    - name: Set up Node.js
-      uses: actions/setup-node@v1
-      with:
-        node-version: 12.x
-    
-    - 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@v4
-      with:
-        author_name: Your Name
-        author_email: mail@example.com
-        message: "Your commit message"
-        add: "*.js"
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Update source code
+        run: eslint "src/**" --fix
+
+      - name: Commit changes
+        uses: EndBug/add-and-commit@v9
+        with:
+          author_name: Your Name
+          author_email: mail@example.com
+          message: 'Your commit message'
+          add: '*.js'
 ```
 
+### Running the action in a different directory
+
 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: 
+jobs:
   run:
     name: Add a text file
     runs-on: ubuntu-latest
@@ -133,20 +307,17 @@ jobs:
       # If you need to, you can check out your repo to a different location
       - uses: actions/checkout@v2
         with:
-          path: "./pathToRepo/"
+          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@v4
+      - uses: EndBug/add-and-commit@v9
         with:
-          message: "Add the very useful text file"
-          add: "*.txt"
-          cwd: "./pathToRepo/"
-          force: true
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          message: 'Add the very useful text file'
+          add: '*.txt --force'
+          cwd: './pathToRepo/'
 ```
 
 ## Contributors ✨
@@ -158,31 +329,77 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
   <tr>
-    <td align="center"><a href="https://github.com/EndBug"><img src="https://avatars1.githubusercontent.com/u/26386270?v=4" 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" 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" 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" 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" 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" 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" 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>
+    <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" 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" 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" 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" 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" 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" 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" width="100px;" alt=""/><br /><sub><b>Connor Clark</b></sub></a><br /><a href="#ideas-connorjclark" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <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>
+    <td align="center"><a href="http://blog.madewithdrew.com/"><img src="https://avatars.githubusercontent.com/u/239123?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Drew Wells</b></sub></a><br /><a href="#ideas-drewwells" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://kotlin.desarrollador-android.com/"><img src="https://avatars.githubusercontent.com/u/7463564?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Javier Segovia Córdoba</b></sub></a><br /><a href="#ideas-JavierSegoviaCordoba" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/Darylgolden"><img src="https://avatars.githubusercontent.com/u/9102529?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Darylgolden</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3ADarylgolden" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/mcargille"><img src="https://avatars.githubusercontent.com/u/20142895?v=4?s=100" width="100px;" alt=""/><br /><sub><b>mcargille</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3Amcargille" title="Bug reports">🐛</a> <a href="https://github.com/EndBug/add-and-commit/commits?author=mcargille" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/secondmanveran"><img src="https://avatars.githubusercontent.com/u/97000801?v=4?s=100" width="100px;" alt=""/><br /><sub><b>secondman</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/commits?author=secondmanveran" title="Documentation">📖</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/prince-chrismc"><img src="https://avatars.githubusercontent.com/u/16867443?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Chris Mc</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/commits?author=prince-chrismc" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://linkedin.com/in/namyalg"><img src="https://avatars.githubusercontent.com/u/53875297?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Namya LG</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/commits?author=Namyalg" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/sconix"><img src="https://avatars.githubusercontent.com/u/921515?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Janne Julkunen</b></sub></a><br /><a href="#ideas-sconix" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://joshcena.com"><img src="https://avatars.githubusercontent.com/u/55398995?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Joshua Chen</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3AJosh-Cena" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="http://akimon658.github.io"><img src="https://avatars.githubusercontent.com/u/81888693?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Akimo</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/commits?author=Akimon658" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://revolunet.com"><img src="https://avatars.githubusercontent.com/u/124937?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Julien Bouquillon</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/commits?author=revolunet" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/AvivPeledTalon"><img src="https://avatars.githubusercontent.com/u/92471076?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Aviv Peled</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3AAvivPeledTalon" title="Bug reports">🐛</a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/onedr0p"><img src="https://avatars.githubusercontent.com/u/213795?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Devin Buhl</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3Aonedr0p" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://erekspeed.com"><img src="https://avatars.githubusercontent.com/u/1176550?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Erek Speed</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3Amelink14" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://kachkaev.uk"><img src="https://avatars.githubusercontent.com/u/608862?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Alexander Kachkaev</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3Akachkaev" title="Bug reports">🐛</a></td>
   </tr>
 </table>
 
-<!-- markdownlint-enable -->
+<!-- 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!
 
+### Additional credits
+
+This action is inspired by [`git-auto-commit-action`](https://github.com/stefanzweifel/git-auto-commit-action) by [Stefan Zweifel](https://github.com/stefanzweifel).
+
 ## License
 
 This action is distributed under the MIT license, check the [license](LICENSE) for more info.

action.yml

@@ -1,44 +1,84 @@
 name: Add & Commit
-description: Add & commit files from a path directly from GitHub Actions
+description: Automatically commit changes made in your workflow run directly to your repo
 
 inputs:
   add:
     description: Arguments for the git add command
     required: false
-    default: "."
+    default: '.'
   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
+  commit:
+    description: Additional arguments for the git commit command
+    required: false
+  committer_name:
+    description: The name of the custom committer you want to use
+    required: false 
+  committer_email:
+    description: The email of the custom committer you want to use
+    required: false
   cwd:
     description: The directory where your repository is located. You should use actions/checkout first to set it up
     required: false
-    default: "."
-  force:
-    description: Whether to use the force option on git add, in order to bypass eventual gitignores
+    default: '.'
+  default_author:
+    description: How the action should fill missing author name or email.
     required: false
-    default: "false"
-  signoff:
-    description: Whether to use the signoff option on git commit
+    default: 'github_actor'
+  fetch:
+    description: Arguments for the git fetch command (if 'false', the action won't fetch the repo)
     required: false
-    default: "false"
+    default: --tags --force
   message:
     description: The message for the commit
     required: false
-    default: Commit from GitHub Actions
-  ref:
-    description: Name of the branch to use, if different from the one that triggered the workflow
+  new_branch:
+    description: The name of the branch to create.
     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. By default, the action does not pull.
+    required: false
+  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
-    default: ""
   tag:
-    description: The name of the tag to add to the new commit
+    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: ""
+  tag_push:
+    description: Arguments for the git push --tags command (any additional argument will be added after --tags)
+    required: false
+    
+  # 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 }}
+
+outputs:
+  committed:
+    description: Whether the action has created a commit.
+  commit_long_sha:
+    description: The complete SHA of the commit that has been created.
+  commit_sha:
+    description: The short 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.
+  tag_pushed:
+    description: Whether the action has pushed a tag.
 
 runs:
   using: node12

lib/entrypoint.sh

@@ -1,88 +0,0 @@
-#!/bin/bash
-set -u
-
-echo "::group::Internal logs"
-
-cd $INPUT_CWD
-echo "Running in $PWD."
-
-# 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 "$INPUT_AUTHOR_EMAIL"
-    git config --global user.name "$INPUT_AUTHOR_NAME"
-}
-
-add() {
-    if $INPUT_FORCE; then f=-f; else f=; fi
-    git add $INPUT_ADD $f
-}
-
-remove() {
-    if [ -n "$INPUT_REMOVE" ]; then git rm $INPUT_REMOVE; fi
-}
-
-commit() {
-    if $INPUT_SIGNOFF; then signoffcmd=--signoff; else signoffcmd=; fi
-    git commit -m "$INPUT_MESSAGE" --author="$INPUT_AUTHOR_NAME <$INPUT_AUTHOR_EMAIL>" $signoffcmd
-}
-
-tag() {
-    if [ -n "$INPUT_TAG" ]; then git tag $INPUT_TAG; fi
-}
-
-# This is needed to make the check work for untracked files
-echo "Staging files..."
-add
-remove
-
-echo "Checking for uncommitted changes in the git working tree..."
-# This section only runs if there have been file changes
-if ! git diff --cached --quiet --exit-code; then
-    git_setup
-
-    git fetch
-
-    # Switch branch (create a new one if it doesn't exist)
-    echo "Switching/creating branch..."
-    git checkout "$INPUT_REF" 2>/dev/null || git checkout -b "$INPUT_REF"
-
-    echo "Pulling from remote..."
-    git fetch && git pull
-
-    echo "Resetting files..."
-    git reset
-
-    echo "Adding files..."
-    add
-
-    echo "Removing files..."
-    remove
-
-    echo "Creating commit..."
-    commit
-
-    echo "Tagging commit..."
-    tag
-
-    echo "Pushing commits to repo..."
-    git push --set-upstream origin "$INPUT_REF"
-
-    echo "Pushing tags to repo..."
-    git push --set-upstream origin "$INPUT_REF" --force --tags
-
-    echo "::endgroup::"
-    echo "Task completed."
-else
-    echo "::endgroup::"
-    echo "Working tree clean. Nothing to commit."
-fi

package.json

@@ -1,11 +1,16 @@
 {
   "name": "add-and-commit",
-  "version": "4.4.0",
+  "version": "9.1.0",
+  "private": true,
   "description": "Add & commit files from a path directly from GitHub Actions",
   "main": "lib/index.js",
   "scripts": {
-    "build": "npm i && ncc build src/main.ts --minify --out lib",
+    "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": {
@@ -26,17 +31,26 @@
   },
   "homepage": "https://github.com/EndBug/add-and-commit#readme",
   "dependencies": {
-    "@actions/core": "^1.1.3",
-    "axios": "^0.19.2"
+    "@actions/core": "^1.9.1",
+    "actions-toolkit": "github:EndBug/actions-toolkit#core-actions",
+    "js-yaml": "^4.1.0",
+    "simple-git": "^3.7.1",
+    "string-argv": "^0.3.1"
   },
   "devDependencies": {
-    "@types/node": "^12.7.12",
-    "@types/shelljs": "^0.8.6",
-    "@typescript-eslint/eslint-plugin": "^2.12.0",
-    "@typescript-eslint/parser": "^2.12.0",
-    "@zeit/ncc": "^0.21.1",
-    "all-contributors-cli": "^6.16.1",
-    "eslint": "^6.8.0",
-    "typescript": "^3.6.4"
+    "@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.34.0",
+    "all-contributors-cli": "^6.20.0",
+    "eslint": "^7.32.0",
+    "eslint-config-prettier": "^8.5.0",
+    "eslint-plugin-prettier": "^4.2.1",
+    "husky": "^8.0.1",
+    "prettier": "^2.7.1",
+    "ts-node": "^10.9.1",
+    "typescript": "^4.7.4",
+    "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/entrypoint.sh

@@ -1,88 +0,0 @@
-#!/bin/bash
-set -u
-
-echo "::group::Internal logs"
-
-cd $INPUT_CWD
-echo "Running in $PWD."
-
-# 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 "$INPUT_AUTHOR_EMAIL"
-    git config --global user.name "$INPUT_AUTHOR_NAME"
-}
-
-add() {
-    if $INPUT_FORCE; then f=-f; else f=; fi
-    git add $INPUT_ADD $f
-}
-
-remove() {
-    if [ -n "$INPUT_REMOVE" ]; then git rm $INPUT_REMOVE; fi
-}
-
-commit() {
-    if $INPUT_SIGNOFF; then signoffcmd=--signoff; else signoffcmd=; fi
-    git commit -m "$INPUT_MESSAGE" --author="$INPUT_AUTHOR_NAME <$INPUT_AUTHOR_EMAIL>" $signoffcmd
-}
-
-tag() {
-    if [ -n "$INPUT_TAG" ]; then git tag $INPUT_TAG; fi
-}
-
-# This is needed to make the check work for untracked files
-echo "Staging files..."
-add
-remove
-
-echo "Checking for uncommitted changes in the git working tree..."
-# This section only runs if there have been file changes
-if ! git diff --cached --quiet --exit-code; then
-    git_setup
-
-    git fetch
-
-    # Switch branch (create a new one if it doesn't exist)
-    echo "Switching/creating branch..."
-    git checkout "$INPUT_REF" 2>/dev/null || git checkout -b "$INPUT_REF"
-
-    echo "Pulling from remote..."
-    git fetch && git pull
-
-    echo "Resetting files..."
-    git reset
-
-    echo "Adding files..."
-    add
-
-    echo "Removing files..."
-    remove
-
-    echo "Creating commit..."
-    commit
-
-    echo "Tagging commit..."
-    tag
-
-    echo "Pushing commits to repo..."
-    git push --set-upstream origin "$INPUT_REF"
-
-    echo "Pushing tags to repo..."
-    git push --set-upstream origin "$INPUT_REF" --force --tags
-
-    echo "::endgroup::"
-    echo "Task completed."
-else
-    echo "::endgroup::"
-    echo "Working tree clean. Nothing to commit."
-fi

src/io.ts

@@ -0,0 +1,252 @@
+import * as core from '@actions/core'
+import { getUserInfo, parseInputArray } from './util'
+
+interface InputTypes {
+  add: string
+  author_name: string
+  author_email: string
+  commit: string | undefined
+  committer_name: string
+  committer_email: string
+  cwd: string
+  default_author: 'github_actor' | 'user_info' | 'github_actions'
+  fetch: string
+  message: string
+  new_branch: string | undefined
+  pathspec_error_handling: 'ignore' | 'exitImmediately' | 'exitAtEnd'
+  pull: string | undefined
+  push: string
+  remove: string | undefined
+  tag: string | undefined
+  tag_push: string | undefined
+
+  github_token: string | undefined
+}
+export type input = keyof InputTypes
+
+interface OutputTypes {
+  committed: 'true' | 'false'
+  commit_long_sha: string | undefined
+  commit_sha: string | undefined
+  pushed: 'true' | 'false'
+  tagged: 'true' | 'false'
+  tag_pushed: 'true' | 'false'
+}
+export type output = keyof OutputTypes
+
+export const outputs: OutputTypes = {
+  committed: 'false',
+  commit_long_sha: undefined,
+  commit_sha: undefined,
+  pushed: 'false',
+  tagged: 'false',
+  tag_pushed: 'false'
+}
+// Setup default output values
+Object.entries(outputs).forEach(([name, value]) => core.setOutput(name, value))
+
+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 function setOutput<T extends output>(name: T, value: OutputTypes[T]) {
+  core.debug(`Setting output: ${name}=${value}`)
+  outputs[name] = value
+  core.setOutput(name, value)
+}
+
+export function logOutputs() {
+  core.startGroup('Outputs')
+  for (const key in outputs) {
+    core.info(`${key}: ${outputs[key]}`)
+  }
+  core.endGroup()
+}
+
+export 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)
+  }
+
+  // #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 fetch
+  if (getInput('fetch')) {
+    let value: string | boolean
+
+    try {
+      value = getInput('fetch', true)
+    } catch {
+      value = getInput('fetch')
+    }
+
+    core.debug(`Currrent fetch option: '${value}' (parsed as ${typeof value})`)
+  }
+  // #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 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 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 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
+}

src/main.ts

@@ -1,68 +1,303 @@
-import { info, setFailed, getInput, warning } from '@actions/core'
-import { execFile } from 'child_process'
+import * as core from '@actions/core'
 import path from 'path'
-import axios from 'axios'
+import simpleGit, { Response } from 'simple-git'
+import { checkInputs, getInput, logOutputs, setOutput } from './io'
+import { log, matchGitArgs, parseInputArray } from './util'
 
-checkInputs().then(() => {
-  const child = execFile(path.join(__dirname, 'entrypoint.sh'), [], { shell: true })
-  child.stdout?.pipe(process.stdout)
-  child.stderr?.pipe(process.stderr)
-}).catch(err => {
-  console.error(err)
-  setFailed(err instanceof Error ? err.message : err)
-})
+const baseDir = path.join(process.cwd(), getInput('cwd') || '')
+const git = simpleGit({ baseDir })
 
-async function checkInputs() {
-  const eventPath = process.env.GITHUB_EVENT_PATH,
-    event = eventPath && require(eventPath),
-    isPR = process.env.GITHUB_EVENT_NAME?.includes('pull_request'),
-    sha = (event?.pull_request?.head?.sha || process.env.GITHUB_SHA) as string,
-    defaultRef = isPR
-      ? event?.pull_request?.head?.ref as string
-      : process.env.GITHUB_REF?.substring(11)
+const exitErrors: Error[] = []
 
-  const actualRef = setDefault('ref', defaultRef || '')
+core.info(`Running in ${baseDir}`)
+;(async () => {
+  await checkInputs()
 
-  let author = event?.head_commit?.author
-  if (sha && !author) {
-    info('Unable to get commit from workflow event: trying with the GitHub API...')
+  core.startGroup('Internal logs')
+  core.info('> Staging files...')
 
-    // https://docs.github.com/en/rest/reference/repos#get-a-commit--code-samples
-    const url = `https://api.github.com/repos/${process.env.GITHUB_REPOSITORY}/commits/${sha}`,
-      headers = process.env.GITHUB_TOKEN ? {
-        Authorization: `Bearer ${process.env.GITHUB_TOKEN}`
-      } : undefined,
-      commit = (await axios.get(url, { headers })).data
+  const ignoreErrors =
+    getInput('pathspec_error_handling') == 'ignore' ? 'pathspec' : 'none'
 
-    author = commit?.commit?.author
+  if (getInput('add')) {
+    core.info('> Adding files...')
+    await add(ignoreErrors)
+  } else core.info('> No files to add.')
+
+  if (getInput('remove')) {
+    core.info('> Removing files...')
+    await remove(ignoreErrors)
+  } 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
+  // continue if there are any changes or if the allow-empty commit argument is included
+  if (
+    changedFiles > 0 ||
+    matchGitArgs(getInput('commit') || '').includes('--allow-empty')
+  ) {
+    core.info(`> Found ${changedFiles} changed files.`)
+    core.debug(
+      `--allow-empty argument detected: ${matchGitArgs(
+        getInput('commit') || ''
+      ).includes('--allow-empty')}`
+    )
+
+    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)
+    )
+
+    let fetchOption: string | boolean
+    try {
+      fetchOption = getInput('fetch', true)
+    } catch {
+      fetchOption = getInput('fetch')
+    }
+    if (fetchOption) {
+      core.info('> Fetching repo...')
+      await git.fetch(
+        matchGitArgs(fetchOption === true ? '' : fetchOption),
+        log
+      )
+    } else core.info('> Not fetching repo.')
+
+    const targetBranch = getInput('new_branch')
+    if (targetBranch) {
+      core.info('> Checking-out branch...')
+
+      if (!fetchOption)
+        core.warning(
+          'Creating a new branch without fetching the repo first could result in an error when pushing to GitHub. Refer to the action README for more info about this topic.'
+        )
+
+      await git
+        .checkout(targetBranch)
+        .then(() => {
+          log(undefined, `'${targetBranch}' branch already existed.`)
+        })
+        .catch(() => {
+          log(undefined, `Creating '${targetBranch}' branch.`)
+          return git.checkoutLocalBranch(targetBranch, log)
+        })
+    }
+
+    const pullOption = getInput('pull')
+    if (pullOption) {
+      core.info('> Pulling from remote...')
+      core.debug(`Current git pull arguments: ${pullOption}`)
+      await git
+        .fetch(undefined, log)
+        .pull(undefined, undefined, matchGitArgs(pullOption), log)
+
+      core.info('> Checking for conflicts...')
+      const status = await git.status(undefined, log)
+
+      if (!status.conflicted.length) {
+        core.info('> No conflicts found.')
+        core.info('> Re-staging files...')
+        if (getInput('add')) await add(ignoreErrors)
+        if (getInput('remove')) await remove(ignoreErrors)
+      } else
+        throw new Error(
+          `There are ${
+            status.conflicted.length
+          } conflicting files: ${status.conflicted.join(', ')}`
+        )
+    } else core.info('> Not pulling from repo.')
+
+    core.info('> Creating commit...')
+    await git
+      .commit(getInput('message'), matchGitArgs(getInput('commit') || ''))
+      .then(async (data) => {
+        log(undefined, data)
+        setOutput('committed', 'true')
+        setOutput('commit_sha', data.commit)
+        await git
+          .revparse(data.commit)
+          .then((long_sha) => setOutput('commit_long_sha', long_sha))
+          .catch((err) => core.warning(`Couldn't parse long SHA:\n${err}`))
+      })
+      .catch((err) => core.setFailed(err))
+
+    if (getInput('tag')) {
+      core.info('> Tagging commit...')
+
+      if (!fetchOption)
+        core.warning(
+          'Creating a tag without fetching the repo first could result in an error when pushing to GitHub. Refer to the action README for more info about this topic.'
+        )
+
+      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('new_branch') || ''
+          } --set-upstream`
+        )
+        await git.push(
+          'origin',
+          getInput('new_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', matchGitArgs(getInput('tag_push') || ''))
+          .then((data) => {
+            setOutput('tag_pushed', 'true')
+            return log(null, data)
+          })
+          .catch((err) => core.setFailed(err))
+      } 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 add(ignoreErrors: 'all' | 'pathspec' | 'none' = 'none') {
+  const input = getInput('add')
+  if (!input) return []
+
+  const parsed = parseInputArray(input)
+  const res: (string | 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
+        })
+    )
   }
 
-  if (author) {
-    setDefault('author_name', author.name)
-    setDefault('author_email', author.email)
-  }
-
-  if (!getInput('author_name') || !getInput('author_email')) {
-    const reason = !eventPath
-      ? 'event path'
-      : isPR
-        ? sha
-          ? 'fetch commit'
-          : 'find commit sha'
-        : !event?.head_commit
-          ? 'find commit'
-          : 'find commit author'
-    warning(`Unable to fetch author info: couldn't ${reason}.`)
-    setDefault('author_name', 'Add & Commit Action')
-    setDefault('author_email', 'actions@github.com')
-  }
-
-  info(`Using '${getInput('author_name')} <${getInput('author_email')}>' as author.`)
-  if (isPR) info(`Running for a PR, the action will use '${actualRef}' as ref.`)
+  return res
 }
 
-function setDefault(input: string, value: string) {
-  const key = 'INPUT_' + input.toUpperCase()
-  if (!process.env[key]) process.env[key] = value
-  return process.env[key] as string
+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
 }

src/util.ts

@@ -0,0 +1,117 @@
+import { parseArgsStringToArgv } from 'string-argv'
+import * as core from '@actions/core'
+import YAML from 'js-yaml'
+import { Toolkit } from 'actions-toolkit'
+import fs from 'fs'
+import { input, output } from './io'
+
+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 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
+}
+
+/**
+ * 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
+ */
+export 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]
+}
+
+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}`
+  }
+}

tsconfig.json

@@ -35,7 +35,7 @@
     // "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). */
+    "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. */
@@ -56,6 +56,7 @@
   },
   "exclude": [
     "node_modules",
-    "**/*.test.ts"
+    "**/*.test.ts",
+    "scripts"
   ]
 }