docs: add issue ref in last change

* 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

@@ -0,0 +1,199 @@
+{
+  "projectName": "add-and-commit",
+  "projectOwner": "EndBug",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": true,
+  "commitConvention": "angular",
+  "contributors": [
+    {
+      "login": "EndBug",
+      "name": "Federico Grandi",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/26386270?v=4",
+      "profile": "https://github.com/EndBug",
+      "contributions": [
+        "code",
+        "doc"
+      ]
+    },
+    {
+      "login": "jactor-rises",
+      "name": "Tor Egil Jacobsen",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/14565088?v=4",
+      "profile": "https://github.com/jactor-rises",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "yelizariev",
+      "name": "Ivan Yelizariev",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/186131?v=4",
+      "profile": "https://twitter.com/yelizariev",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "jhhughes",
+      "name": "jhhughes",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/13724293?v=4",
+      "profile": "https://github.com/jhhughes",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "DmitrijOkeanij",
+      "name": "Дмитрий Океаний",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/10674646?v=4",
+      "profile": "https://sunengine.site",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "brahma-dev",
+      "name": "Brahma Dev",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/1793295?v=4",
+      "profile": "https://github.com/brahma-dev",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "felixlapalma",
+      "name": "Felix Rojo Lapalma",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/38389683?v=4",
+      "profile": "https://github.com/felixlapalma",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "RobinWijnant",
+      "name": "Robin Wijnant",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/33033209?v=4",
+      "profile": "http://robinwijnant.me",
+      "contributions": [
+        "bug",
+        "code"
+      ]
+    },
+    {
+      "login": "onilton",
+      "name": "Onilton Maciel",
+      "avatar_url": "https://avatars2.githubusercontent.com/u/725676?v=4",
+      "profile": "https://github.com/onilton",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "jsoref",
+      "name": "Josh Soref",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/2119212?v=4",
+      "profile": "https://github.com/jsoref",
+      "contributions": [
+        "doc"
+      ]
+    },
+    {
+      "login": "ToMe25",
+      "name": "ToMe25",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/38815969?v=4",
+      "profile": "https://github.com/ToMe25",
+      "contributions": [
+        "code",
+        "ideas"
+      ]
+    },
+    {
+      "login": "JonasJacobsUserspace",
+      "name": "JonasJacobsUserspace",
+      "avatar_url": "https://avatars0.githubusercontent.com/u/59708720?v=4",
+      "profile": "https://github.com/JonasJacobsUserspace",
+      "contributions": [
+        "bug"
+      ]
+    },
+    {
+      "login": "pvogt09",
+      "name": "pvogt09",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/50047961?v=4",
+      "profile": "https://github.com/pvogt09",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "connorjclark",
+      "name": "Connor Clark",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/4071474?v=4",
+      "profile": "http://hoten.cc",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "login": "Cyberbeni",
+      "name": "Benedek Kozma",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/8356175?v=4",
+      "profile": "https://github.com/Cyberbeni",
+      "contributions": [
+        "ideas"
+      ]
+    },
+    {
+      "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"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "skipCi": true
+}

.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,38 @@
+module.exports = {
+  env: {
+    commonjs: true,
+    es6: true,
+    node: true
+  },
+  extends: [
+    'eslint:recommended',
+    'prettier/@typescript-eslint',
+    'plugin:prettier/recommended'
+  ],
+  globals: {},
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 6,
+    sourceType: 'module'
+  },
+  plugins: ['@typescript-eslint'],
+  rules: {
+    'prettier/prettier': 'warn',
+    'no-cond-assign': [2, 'except-parens'],
+    'no-unused-vars': 0,
+    '@typescript-eslint/no-unused-vars': 1,
+    'no-empty': [
+      'error',
+      {
+        allowEmptyCatch: true
+      }
+    ],
+    'prefer-const': [
+      'warn',
+      {
+        destructuring: 'all'
+      }
+    ],
+    'spaced-comment': 'warn'
+  }
+}

.github/ISSUE_TEMPLATE/blank-issue.md

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

.github/ISSUE_TEMPLATE/bug_report.md

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

.github/ISSUE_TEMPLATE/config.yml

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

.github/ISSUE_TEMPLATE/question.md

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

.github/dependabot.yml

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

.github/labels.yml

@@ -0,0 +1,80 @@
+# General purpose
+- 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: 'Issues and PRs that should not be labeled as stale or closed if they remain inactive.'
+  aliases: []
+
+- name: 'status: stale'
+  color: fbca04
+  description: 'Inactive issues and PRs.'
+  aliases: ['stale']
+
+- name: 'status: wontfix'
+  color: ffffff
+  description: 'This will not be worked on.'
+  aliases: ['wontfix']
+
+- name: 'type: automation'
+  color: 2fc904
+  description: 'About actions workflows and automation.'
+  aliases: ['automation', 'actions']
+
+- name: 'type: bug'
+  color: d73a4a
+  description: 'Verified problems that need to be worked on.'
+  aliases: ['bug']
+
+- name: 'type: dependencies'
+  color: 0366d6
+  description: 'Pull requests that update a dependency file'
+  aliases: ['dependencies']
+
+- name: 'type: duplicate'
+  color: cfd3d7
+  description: 'This issue or pull request already exists.'
+  aliases: ['duplicate']
+
+- name: 'type: enhancement'
+  color: a2eeef
+  description: 'New feature or request.'
+  aliases: ['enhancement']
+
+- name: 'type: invalid'
+  color: e4e669
+  description: "This doesn't seem right."
+  aliases: ['invalid']
+
+- name: 'type: maintenance'
+  color: 0075ca
+  description: "Documentation improvements and code refactoring, doesn't affect functionality."
+  aliases: ['documentation', 'docs']
+
+- 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']
+
+- name: 'type: security'
+  color: 'ee0701'
+  description: 'Pull requests that address a security vulnerability.'
+  aliases: ['security']

.github/workflows/build.yml

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

.github/workflows/docs.yml

@@ -0,0 +1,31 @@
+name: Docs
+on:
+  push:
+    branches:
+      - master
+    paths:
+      - .all-contributorsrc
+      - .github/workflows/docs.yml
+  workflow_dispatch:
+
+jobs:
+  contributors:
+    name: Update contributors badge
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+
+      - uses: actions/setup-node@v1
+        with:
+          node-version: 12.x
+
+      - run: npm install
+
+      - run: npm run all-contributors-badge
+
+      - uses: EndBug/add-and-commit@v4.0.0
+        with:
+          message: '[auto] docs: update contributors badge'
+          add: README.md
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/export-labels.yml

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

.github/workflows/label-sync.yml

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

.github/workflows/stale.yml

@@ -0,0 +1,21 @@
+name: 'Handle stale issues and PRs'
+on:
+  schedule:
+    - cron: '0 0 * * *'
+  workflow_dispatch:
+
+jobs:
+  stale:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/stale@v3
+        with:
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
+          stale-issue-message: 'This issue is being marked as "stale" because it has been open 20 days with no activity. Remove the "stale" label or comment, otherwise this will be closed in 5 days.'
+          stale-issue-label: 'status: stale'
+          exempt-issue-labels: 'status: pinned'
+          stale-pr-message: 'This PR is being marked as "stale" because it has been open 20 days with no activity. Remove the "stale" label or comment, otherwise this will be closed in 5 days.'
+          stale-pr-label: 'status: stale'
+          exempt-pr-labels: 'status: pinned'
+          days-before-stale: 20
+          days-before-close: 5

.github/workflows/versioning.yml

@@ -2,13 +2,13 @@ name: Keep the versions up-to-date
 
 on:
   release:
-    types: [published]
+    types: [published, edited]
 
 jobs:
   actions-tagger:
     runs-on: windows-latest
     steps:
-      - uses: Actions-R-Us/actions-tagger@latest
+      - uses: Actions-R-Us/actions-tagger@v1
         with:
           publish_latest: true
         env:

.gitignore

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

.prettierrc

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

CHANGELOG.md

@@ -0,0 +1,218 @@
+# 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]
+
+## [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/v5.3.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

README.md

@@ -1,100 +1,211 @@
 # Add & Commit
 
-You can use this GitHub Action to commit changes made in your workflow run directly to your repo: for example, you use it to lint your code, update documentation, commit updated builds and so on...
+<a href="https://github.com/search?o=desc&q=EndBug%2Fadd-and-commit+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code" target="_blank" title="Public workflows that use this action."><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3DEndBug%2Fadd-and-commit%26badge%3Dtrue" alt="Public workflows that use this action."></a>
+[![All Contributors](https://img.shields.io/badge/all_contributors-20-orange.svg?style=flat)](#contributors-)
+
+You can use this GitHub Action to commit changes made in your workflow run directly to your repo: for example, you use it to lint your code, update documentation, commit updated builds, etc....
 
 This is **heavily** inspired by [git-auto-commit-action](https://github.com/stefanzweifel/git-auto-commit-action) (by [Stefan Zweifel](https://github.com/stefanzweifel)): that action automatically detects changed files and commits them. While this is useful for most situations, this doesn't commit untracked files and can sometimes commit unintended changes (such as `package-lock.json` or similar, that may have happened during previous steps).  
-This action lets you choose the path that you want to use when adding & committing changes, so that it works as you would normally do using `git` on your machine.
+This action lets you choose the path that you want to use when adding & committing changes so that it works as you would normally do using `git` on your machine.
 
 ## Usage
 
 Add a step like this to your workflow:
 
 ```yaml
-- name: Commit changes # This is the step name that will be displayed in your runs
-  uses: EndBug/add-and-commit@v2 # You can change this to use a specific version
-  with: # See more info about inputs below
+- uses: EndBug/add-and-commit@v5 # 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 email of the user that will be displayed as the author of the commit
+    # Default: author of the commit that triggered the run
     author_email: mail@example.com
-    message: "Your commit message"
-    path: "."
-    pattern: "*.js"
-    force: false
+
+    # Name of the branch to use, if different from the one that triggered the workflow
+    # Default: the branch that triggered the run
+    branch: some-branch
+
+    # The local path to the directory where your repository is located. You should use actions/checkout first to set it up
+    # Default: '.'
+    cwd: './path/to/the/repo'
+
+    # The message for the commit
+    # Default: 'Commit from GitHub Actions (name of the workflow)'
+    message: 'Your commit message'
+
+    # The flag used on the pull strategy
+    # Default: '--no-rebase'
+    pull_strategy: '--no-rebase or --no-ff or --rebase'
+
+    # Whether to push the commit and, if any, its tags to the repo (only `true` and `false` are accepted)
+    # Default: true
+    push: false
+
+    # The arguments for the `git rm` command (see the paragraph below for more info)
+    # Default: ''
+    remove: './dir/old_file.js'
+
+    # Whether to use the --signoff option on `git commit` (only `true` and `false` are accepted)
+    # Default: false
+    signoff: true
+
+    # Arguments for the git tag command (the tag name always needs to be the first word not preceded by an hyphen)
+    # Default: ''
+    tag: 'v1.0.0 --force'
+
   env:
+    # This is necessary in order to push a commit to the repo
     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Leave this line unchanged
 ```
 
-### Inputs:
-
-- `author_name` : the name of the user that will be displayed as the author of the commit, defaults to the author of the commit that triggered the run
-- `author_email` : the email of the user that will be displayed as the author of the commit, defaults to the author of the commit that triggered the run
-- `message` : the message for the commit
-- `path` : the path(s) to stage files from
-- `pattern` : the pattern that matches file names
-- `force` : whether to use the force option on git add, in order to bypass eventual gitignores
-
 ### Environment variables:
 
 The only `env` variable required is the token for the action to run: GitHub generates one automatically, but you need to pass it through `env` to make it available to actions. You can find more about `GITHUB_TOKEN` [here](https://help.github.com/en/articles/virtual-environments-for-github-actions#github_token-secret).  
-With that said, you can just copy the example line and don't worry about it. If you do want to use a different token you can pass that in, but I wouldn't see any possible advantage in doing so.
+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.
+
+### Adding files:
+
+The action adds files using a regular `git add` command, so you can put every kind of argument in the `add` option. For example, if you want to force-add a file: `./path/to/file.txt --force`.  
+The script will not stop if one of the git commands fails. 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:
 
-This action only **adds** files so in order to commit a file deletion you need to stage that separately: for that, you can run `git rm` in a previous step. Here's a quick example:
+You can delete files with the `remove` option: that runs a `git rm` command that will stage the files in the given path for removal. As with the `add` argument, you can use every option `git rm` allows (e.g. add `--force` to ignore `.gitignore` rules).  
+The script will not stop if one of the git commands fails. 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.
 
-```yaml
-- run: git rm delete_me.txt
+### Tagging:
 
-- uses: EndBug/add-and-commit@v2
-  with:
-    author_name: Your Name
-    author_email: mail@example.com
-    message: "Remove file"
-    path: "."
-    pattern: "*.js"  # The path is not important, the file will get removed anyway: that means you can still use the action as usual
-    force: true
-  env:
-    GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-```
+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).
 
-### Example:
+### Outputs:
 
-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:
+The action provides these outputs:
+
+- `committed`: whether the action has created a commit (`'true'` or `'false'`)
+- `pushed`: whether the action has pushed to teh remote(`'true'` or `'false'`)
+- `tagged`: whether the action has created a tag (`'true'` or `'false'`)
+
+For more info on how to use outputs, see ["Context and expression syntax"](https://docs.github.com/en/free-pro-team@latest/actions/reference/context-and-expression-syntax-for-github-actions).
+
+### Examples:
+
+Do you want to lint your JavaScript files, located in the `src` folder, with ESLint, so that fixable changes are done without your intervention? You can use a workflow like this:
 
 ```yaml
 name: Lint source code
 on: push
 
-jobs: 
+jobs:
   run:
     name: Lint with ESLint
     runs-on: ubuntu-latest
-    steps: 
-    - name: Checkout repo
-      uses: actions/checkout@v1
+    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@v2 
-      with:
-        author_name: Your Name
-        author_email: mail@example.com
-        message: "Your commit message"
-        path: "."
-        pattern: "*.js"
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Update source code
+        run: eslint "src/**" --fix
+
+      - name: Commit changes
+        uses: EndBug/add-and-commit@v5
+        with:
+          author_name: Your Name
+          author_email: mail@example.com
+          message: 'Your commit message'
+          add: '*.js'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
+If you need to run the action on a repository that is not located in [`$GITHUB_WORKSPACE`](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/using-environment-variables#default-environment-variables), you can use the `cwd` option: the action uses a `cd` normal command, so the path should follow bash standards.
+
+```yaml
+name: Use a different repository directory
+on: push
+
+jobs:
+  run:
+    name: Add a text file
+    runs-on: ubuntu-latest
+
+    steps:
+      # If you need to, you can check out your repo to a different location
+      - uses: actions/checkout@v2
+        with:
+          path: './pathToRepo/'
+
+      # You can make whatever type of change to the repo...
+      - run: echo "123" > ./pathToRepo/file.txt
+
+      # ...and then use the action as you would normally do, but providing the path to the repo
+      - uses: EndBug/add-and-commit@v5
+        with:
+          message: 'Add the very useful text file'
+          add: '*.txt --force'
+          cwd: './pathToRepo/'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+```
+
+## Contributors ✨
+
+Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/EndBug"><img src="https://avatars1.githubusercontent.com/u/26386270?v=4" 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>
+  </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>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/Cyberbeni"><img src="https://avatars1.githubusercontent.com/u/8356175?v=4" width="100px;" alt=""/><br /><sub><b>Benedek Kozma</b></sub></a><br /><a href="#ideas-Cyberbeni" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/coffeegoddd"><img src="https://avatars3.githubusercontent.com/u/43383835?v=4" width="100px;" alt=""/><br /><sub><b>Dustin Brown</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3Acoffeegoddd" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/Chocrates"><img src="https://avatars1.githubusercontent.com/u/1758164?v=4" width="100px;" alt=""/><br /><sub><b>Chris McIntosh</b></sub></a><br /><a href="https://github.com/EndBug/add-and-commit/issues?q=author%3AChocrates" title="Bug reports">🐛</a></td>
+    <td align="center"><a href="https://github.com/kbsali"><img src="https://avatars0.githubusercontent.com/u/53676?v=4" width="100px;" alt=""/><br /><sub><b>Kevin Saliou</b></sub></a><br /><a href="#ideas-kbsali" title="Ideas, Planning, & Feedback">🤔</a></td>
+    <td align="center"><a href="https://github.com/ewjoachim"><img src="https://avatars0.githubusercontent.com/u/1457576?v=4" 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" width="100px;" alt=""/><br /><sub><b>Tim Schwenke</b></sub></a><br /><a href="#ideas-trallnag" title="Ideas, Planning, & Feedback">🤔</a></td>
+  </tr>
+</table>
+
+<!-- markdownlint-enable -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
+
 ## License
 
 This action is distributed under the MIT license, check the [license](LICENSE) for more info.

action.yml

@@ -2,32 +2,54 @@ name: Add & Commit
 description: Add & commit files from a path directly from GitHub Actions
 
 inputs:
+  add:
+    description: Arguments for the git add command
+    required: false
+    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
-  force:
-    description: Whether to use the force option on git add, in order to bypass eventual gitignores
+  branch:
+    description: Name of the branch to use, if different from the one that triggered the workflow
     required: false
-    default: "false"
+  cwd:
+    description: The directory where your repository is located. You should use actions/checkout first to set it up
+    required: false
+    default: '.'
   message:
     description: The message for the commit
     required: false
-    default: Commit from GitHub Actions
-  path:
-    description: The path to stage files from
+  pull_strategy:
+    description: The flag used on the pull strategy
     required: false
-    default: "."
-  pattern:
-    description: The pattern that mathces file names
+    default: '--no-rebase'
+  push:
+    description: Whether to push the commit and, if any, its tags to the repo
     required: false
-    default: "*.*"
+  remove:
+    description: Arguments for the git rm command
+    required: false
+  signoff:
+    description: Whether to use the --signoff option on git commit
+    required: false
+  tag:
+    description: Arguments for the git tag command (the tag name always needs to be the first word not preceded by a hyphen)
+    required: false
+
+outputs:
+  committed:
+    description: Whether the action has created a commit.
+  pushed:
+    description: Whether the action has pushed to the remote.
+  tagged:
+    description: Whether the action has created a tag.
 
 runs:
   using: node12
-  main: lib/main.js
+  main: lib/index.js
 
 branding:
   icon: git-commit

lib/main.js

@@ -1 +0,0 @@
-"use strict";var __importStar=this&&this.__importStar||function(a){if(a&&a.__esModule)return a;var b={};if(null!=a)for(var c in a)Object.hasOwnProperty.call(a,c)&&(b[c]=a[c]);return b["default"]=a,b};Object.defineProperty(exports,"__esModule",{value:!0});const core=__importStar(require("@actions/core")),shell=__importStar(require("shelljs")),path=__importStar(require("path"));try{checkInputs(),shell.exec(path.join(__dirname,"../src/entrypoint.sh"))}catch(a){core.setFailed(a)}function checkInputs(){const a=process.env.GITHUB_EVENT_PATH;if(a){const{author:b}=require(a).head_commit;process.env.INPUT_AUTHOR_NAME||(process.env.INPUT_AUTHOR_NAME=b.name),process.env.INPUT_AUTHOR_EMAIL||(process.env.INPUT_AUTHOR_EMAIL=b.email)}else core.warning("No event path available, unable to fetch author info."),process.env.INPUT_AUTHOR_NAME||(process.env.INPUT_AUTHOR_NAME="Add & Commit Action"),process.env.INPUT_AUTHOR_EMAIL||(process.env.INPUT_AUTHOR_EMAIL="actions@github.com");core.info(`Using '${process.env.INPUT_AUTHOR_NAME} <${process.env.INPUT_AUTHOR_EMAIL}>' as author.`)}

package.json

@@ -1,15 +1,21 @@
 {
   "name": "add-and-commit",
-  "version": "2.3.0",
+  "version": "6.0.0",
   "description": "Add & commit files from a path directly from GitHub Actions",
-  "main": "lib/main.js",
+  "main": "lib/index.js",
   "scripts": {
-    "build": "npm run compile && npm run minify && rm build/*.js",
-    "compile": "tsc",
-    "minify": "minify build -d lib",
-    "dist": "echo \"Preparing for distribution...\" && npm i --only=prod && git add -f node_modules && git commit -m \"Commit dist files\"",
+    "build": "ncc build src/main.ts --minify --out lib",
+    "watch": "ncc build src/main.ts --watch --out lib",
+    "lint:fix": "eslint --ext .ts --fix src",
+    "all-contributors-badge": "ts-node scripts/all-contributors-badge",
+    "changelog": "ts-node scripts/changelog.ts",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
+  "husky": {
+    "hooks": {
+      "pre-commit": "npm run build && git add lib"
+    }
+  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/EndBug/add-and-commit.git"
@@ -28,16 +34,25 @@
   },
   "homepage": "https://github.com/EndBug/add-and-commit#readme",
   "dependencies": {
-    "@actions/core": "^1.1.3",
-    "shelljs": "^0.8.3"
+    "@actions/core": "^1.2.6",
+    "axios": "^0.21.0",
+    "js-yaml": "^3.14.1",
+    "simple-git": "^2.27.0"
   },
   "devDependencies": {
-    "@types/node": "^12.7.12",
-    "@types/shelljs": "^0.8.6",
-    "@typescript-eslint/eslint-plugin": "^2.12.0",
-    "@typescript-eslint/parser": "^2.12.0",
-    "babel-minify": "^0.5.1",
+    "@types/js-yaml": "^3.12.5",
+    "@types/node": "^12.12.54",
+    "@typescript-eslint/eslint-plugin": "^2.34.0",
+    "@typescript-eslint/parser": "^2.34.0",
+    "@vercel/ncc": "^0.26.1",
+    "all-contributors-cli": "^6.19.0",
     "eslint": "^6.8.0",
-    "typescript": "^3.6.4"
+    "eslint-config-prettier": "^6.15.0",
+    "eslint-plugin-prettier": "^3.3.0",
+    "husky": "^4.3.6",
+    "prettier": "^2.2.1",
+    "ts-node": "^9.1.1",
+    "typescript": "^4.1.3",
+    "yamljs": "^0.3.0"
   }
 }

scripts/all-contributors-badge.ts

@@ -0,0 +1,24 @@
+import * as fs from 'fs'
+import { resolve } from 'path'
+
+function path(...segments: string[]) {
+  return resolve(__dirname, '..', ...segments)
+}
+
+const README = fs.readFileSync(path('README.md'), { encoding: 'utf8' }),
+  { contributors } = JSON.parse(
+    fs.readFileSync(path('.all-contributorsrc'), { encoding: 'utf8' })
+  )
+if (!(contributors instanceof Array)) throw new Error('Invalid config file')
+
+const updatedREADME = README.split('\n')
+  .map((line) =>
+    line.startsWith(
+      '[![All Contributors](https://img.shields.io/badge/all_contributors-'
+    )
+      ? `[![All Contributors](https://img.shields.io/badge/all_contributors-${contributors.length}-orange.svg?style=flat)](#contributors-)`
+      : line
+  )
+  .join('\n')
+
+fs.writeFileSync(path('README.md'), updatedREADME)

scripts/changelog.ts

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

src/main.ts

@@ -1,24 +1,424 @@
-import * as core from '@actions/core'
-import * as shell from 'shelljs'
-import * as path from 'path'
+import {
+  info,
+  setFailed,
+  warning,
+  debug,
+  startGroup,
+  endGroup
+} from '@actions/core'
+import axios from 'axios'
+import path from 'path'
+import simpleGit, { Response } from 'simple-git'
+import YAML from 'js-yaml'
+import { getInput, Input, log, outputs, parseBool, setOutput } from './util'
 
-try {
-  checkInputs()
-  shell.exec(path.join(__dirname, '../src/entrypoint.sh'))
-} catch (e) {
-  core.setFailed(e)
-}
+const baseDir = path.join(process.cwd(), getInput('cwd') || '')
+const git = simpleGit({ baseDir })
+console.log(`Running in ${baseDir}`)
+;(async () => {
+  await checkInputs().catch(setFailed)
 
-function checkInputs() {
-  const eventPath = process.env.GITHUB_EVENT_PATH
-  if (eventPath) {
-    const { author } = require(eventPath).head_commit
-    if (!process.env.INPUT_AUTHOR_NAME) process.env.INPUT_AUTHOR_NAME = author.name
-    if (!process.env.INPUT_AUTHOR_EMAIL) process.env.INPUT_AUTHOR_EMAIL = author.email
+  startGroup('Internal logs')
+  info('> Staging files...')
+
+  if (getInput('add')) {
+    info('> Adding files...')
+    await add()
+  } else info('> No files to add.')
+
+  if (getInput('remove')) {
+    info('> Removing files...')
+    await remove()
+  } else info('> No files to remove.')
+
+  info('> Checking for uncommitted changes in the git working tree...')
+  const changedFiles = (await git.diffSummary(['--cached'])).files.length
+  if (changedFiles > 0) {
+    info(`> Found ${changedFiles} changed files.`)
+
+    await git
+      .addConfig('user.email', getInput('author_email'), undefined, log)
+      .addConfig('user.name', getInput('author_name'), undefined, log)
+    debug(
+      '> Current git config\n' +
+        JSON.stringify((await git.listConfig()).all, null, 2)
+    )
+
+    await git.fetch(['--tags', '--force'], log)
+
+    info('> Switching/creating branch...')
+    await git
+      .checkout(getInput('branch'), undefined, log)
+      .catch(() => git.checkoutLocalBranch(getInput('branch'), log))
+
+    info('> Pulling from remote...')
+    await git.fetch(undefined, log).pull(
+      undefined,
+      undefined,
+      {
+        [getInput('pull_strategy')]: null
+      },
+      log
+    )
+
+    info('> Re-staging files...')
+    if (getInput('add')) await add({ ignoreErrors: true })
+    if (getInput('remove')) await remove({ ignoreErrors: true })
+
+    info('> Creating commit...')
+    await git.commit(
+      getInput('message'),
+      undefined,
+      {
+        '--author': `"${getInput('author_name')} <${getInput(
+          'author_email'
+        )}>"`,
+        ...(getInput('signoff')
+          ? {
+              '--signoff': null
+            }
+          : {})
+      },
+      (err, data?) => {
+        if (data) setOutput('committed', 'true')
+        return log(err, data)
+      }
+    )
+
+    if (getInput('tag')) {
+      info('> Tagging commit...')
+      await git
+        .tag(getInput('tag').split(' '), (err, data?) => {
+          if (data) setOutput('tagged', 'true')
+          return log(err, data)
+        })
+        .then((data) => {
+          setOutput('tagged', 'true')
+          return log(null, data)
+        })
+        .catch((err) => setFailed(err))
+    } else info('> No tag info provided.')
+
+    if (getInput('push')) {
+      info('> Pushing commit to repo...')
+      await git.push(
+        'origin',
+        getInput('branch'),
+        { '--set-upstream': null },
+        (err, data?) => {
+          if (data) setOutput('pushed', 'true')
+          return log(err, data)
+        }
+      )
+
+      if (getInput('tag')) {
+        info('> Pushing tags to repo...')
+        await git
+          .pushTags('origin', undefined, (e, d?) => log(undefined, e || d))
+          .catch(() => {
+            info('> Tag push failed: deleting remote tag and re-pushing...')
+            return git
+              .push(
+                undefined,
+                undefined,
+                {
+                  '--delete': null,
+                  origin: null,
+                  [getInput('tag')
+                    .split(' ')
+                    .filter((w) => !w.startsWith('-'))[0]]: null
+                },
+                log
+              )
+              .pushTags('origin', undefined, log)
+          })
+      } else info('> No tags to push.')
+    } else info('> Not pushing anything.')
+
+    endGroup()
+    info('> Task completed.')
   } else {
-    core.warning('No event path available, unable to fetch author info.')
-    if (!process.env.INPUT_AUTHOR_NAME) process.env.INPUT_AUTHOR_NAME = 'Add & Commit Action'
-    if (!process.env.INPUT_AUTHOR_EMAIL) process.env.INPUT_AUTHOR_EMAIL = 'actions@github.com'
+    endGroup()
+    info('> Working tree clean. Nothing to commit.')
   }
-  core.info(`Using '${process.env.INPUT_AUTHOR_NAME} <${process.env.INPUT_AUTHOR_EMAIL}>' as author.`)
+})()
+  .then(logOutputs)
+  .catch((e) => {
+    endGroup()
+    logOutputs()
+    setFailed(e)
+  })
+
+async function checkInputs() {
+  function setInput(input: Input, value: string | undefined) {
+    if (value) return (process.env[`INPUT_${input.toUpperCase()}`] = value)
+    else return delete process.env[`INPUT_${input.toUpperCase()}`]
+  }
+  function setDefault(input: Input, value: string) {
+    if (!getInput(input)) setInput(input, value)
+    return getInput(input)
+  }
+
+  const eventPath = process.env.GITHUB_EVENT_PATH,
+    event = eventPath && require(eventPath),
+    token = process.env.GITHUB_TOKEN,
+    isPR = process.env.GITHUB_EVENT_NAME?.includes('pull_request'),
+    sha = (event?.pull_request?.head?.sha || process.env.GITHUB_SHA) as string,
+    defaultBranch = isPR
+      ? (event?.pull_request?.head?.ref as string)
+      : process.env.GITHUB_REF?.substring(11)
+
+  // #region GITHUB_TOKEN
+  if (!token)
+    warning(
+      'The GITHUB_TOKEN env variable is missing: the action may not work as expected.'
+    )
+  // #endregion
+
+  // #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)
+      info('Add input parsed as single string, running 1 git add command.')
+    else if (parsed.length > 1)
+      info(
+        `Add input parsed as string array, running ${parsed.length} git add commands.`
+      )
+    else setFailed('Add input: array length < 1')
+  }
+  if (getInput('remove')) {
+    const parsed = parseInputArray(getInput('remove'))
+    if (parsed.length == 1)
+      info('Remove input parsed as single string, running 1 git rm command.')
+    else if (parsed.length > 1)
+      info(
+        `Remove input parsed as string array, running ${parsed.length} git rm commands.`
+      )
+    else setFailed('Remove input: array length < 1')
+  }
+  // #endregion
+
+  // #region author_name, author_email
+  let author = event?.head_commit?.author
+  if (sha && !author) {
+    info(
+      '> Unable to get commit from workflow event: trying with the GitHub API...'
+    )
+
+    // 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 = token
+        ? {
+            Authorization: `Bearer ${token}`
+          }
+        : undefined,
+      commit = (
+        await axios.get(url, { headers }).catch((err) => {
+          startGroup('Request error:')
+          info(`> Request URL: ${url}\b${err}`)
+          endGroup()
+          return undefined
+        })
+      )?.data
+
+    author = commit?.commit?.author
+  }
+
+  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.`
+  )
+  // #endregion
+
+  // #region message
+  setDefault(
+    'message',
+    `Commit from GitHub Actions (${process.env.GITHUB_WORKFLOW})`
+  )
+  info(`> Using "${getInput('message')}" as commit message.`)
+  // #endregion
+
+  // #region branch
+  const branch = setDefault('branch', defaultBranch || '')
+  if (isPR) info(`> Running for a PR, the action will use '${branch}' as ref.`)
+  // #endregion
+
+  // #region signoff
+  if (getInput('signoff')) {
+    const parsed = parseBool(getInput('signoff'))
+
+    if (parsed === undefined)
+      throw new Error(
+        `"${getInput(
+          'signoff'
+        )}" is not a valid value for the 'signoff' input: only "true" and "false" are allowed.`
+      )
+
+    if (!parsed) setInput('signoff', undefined)
+
+    debug(
+      `Current signoff option: ${getInput('signoff')} (${typeof getInput(
+        'signoff'
+      )})`
+    )
+  }
+
+  // #endregion
+
+  // #region push
+  setDefault('push', 'true')
+  if (getInput('push')) {
+    // It's just to scope the parsed constant
+    const parsed = parseBool(getInput('push'))
+
+    if (parsed === undefined)
+      throw new Error(
+        `"${getInput(
+          'push'
+        )}" is not a valid value for the 'push' input: only "true" and "false" are allowed.`
+      )
+
+    if (!parsed) setInput('push', undefined)
+
+    debug(
+      `Current push option: ${getInput('push')} (${typeof getInput('push')})`
+    )
+  }
+  // #endregion
+}
+
+async function add({ logWarning = true, ignoreErrors = false } = {}): Promise<
+  (void | Response<void>)[]
+> {
+  const input = getInput('add')
+  if (!input) return []
+
+  const parsed = parseInputArray(input)
+  const res: (void | Response<void>)[] = []
+
+  for (const args of parsed) {
+    res.push(
+      // Push the result of every git command (which are executed in order) to the array
+      // If any of them fails, the whole function will return a Promise rejection
+      await git
+        .add(args.split(' '), (err: any, data?: any) =>
+          log(ignoreErrors ? null : err, data)
+        )
+        .catch((e: Error) => {
+          if (ignoreErrors) return
+          if (
+            e.message.includes('fatal: pathspec') &&
+            e.message.includes('did not match any files') &&
+            logWarning
+          )
+            warning(`Add command did not match any file:\n  git add ${args}`)
+          else throw e
+        })
+    )
+  }
+
+  return res
+}
+
+async function remove({
+  logWarning = true,
+  ignoreErrors = false
+} = {}): 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(args.split(' '), (e: any, d?: any) =>
+          log(ignoreErrors ? null : e, d)
+        )
+        .catch((e: Error) => {
+          if (ignoreErrors) return
+          if (
+            e.message.includes('fatal: pathspec') &&
+            e.message.includes('did not match any files')
+          )
+            logWarning &&
+              warning(
+                `Remove command did not match any file:\n  git rm ${args}`
+              )
+          else throw e
+        })
+    )
+  }
+
+  return res
+}
+
+/**
+ * Tries to parse a JSON array, then a YAML array.
+ * If both fail, it returns an array containing the input value as its only element
+ */
+function parseInputArray(input: string): string[] {
+  try {
+    const json = JSON.parse(input)
+    if (
+      json &&
+      Array.isArray(json) &&
+      json.every((e) => typeof e == 'string')
+    ) {
+      debug(`Input parsed as JSON array of length ${json.length}`)
+      return json
+    }
+  } catch {}
+
+  try {
+    const yaml = YAML.safeLoad(input)
+    if (
+      yaml &&
+      Array.isArray(yaml) &&
+      yaml.every((e) => typeof e == 'string')
+    ) {
+      debug(`Input parsed as YAML array of length ${yaml.length}`)
+      return yaml
+    }
+  } catch {}
+
+  debug('Input parsed as single string')
+  return [input]
+}
+
+function logOutputs() {
+  startGroup('Outputs')
+  for (const key in outputs) {
+    info(`${key}: ${outputs[key]}`)
+  }
+  endGroup()
 }

src/util.ts

@@ -0,0 +1,44 @@
+import * as core from '@actions/core'
+
+export type Input =
+  | 'add'
+  | 'author_name'
+  | 'author_email'
+  | 'branch'
+  | 'cwd'
+  | 'message'
+  | 'pull_strategy'
+  | 'push'
+  | 'remove'
+  | 'signoff'
+  | 'tag'
+
+export const outputs = {
+  committed: 'false',
+  pushed: 'false',
+  tagged: 'false'
+}
+export type Output = keyof typeof outputs
+
+export function getInput(name: Input) {
+  return core.getInput(name)
+}
+
+export function log(err: any | Error, data?: any) {
+  if (data) console.log(data)
+  if (err) core.error(err)
+}
+
+export function parseBool(value: any) {
+  try {
+    const parsed = JSON.parse(value)
+    if (typeof parsed == 'boolean') return parsed
+  } catch {}
+}
+
+export function setOutput(name: Output, value: 'true' | 'false') {
+  core.debug(`Setting output: ${name}=${value}`)
+  outputs[name] = value
+  return core.setOutput(name, value)
+}
+for (const key in outputs) setOutput(key as Output, outputs[key])

tsconfig.json

@@ -56,6 +56,7 @@
   },
   "exclude": [
     "node_modules",
-    "**/*.test.ts"
+    "**/*.test.ts",
+    "scripts"
   ]
 }