release: v5.3.0

This is just not to introduce breaking changes

.eslintrc

@@ -1,64 +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": 0,
-    "@typescript-eslint/no-unused-vars": "warn",
-    "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/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/workflows/build.yml

@@ -1,6 +1,8 @@
 name: Build
 on:
   push:
+    branches:
+      - master
     paths:
       - src/**
       - .github/workflows/build.yml
@@ -27,10 +29,3 @@ jobs:
           add: lib
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
-      - uses: EndBug/add-and-commit@v4
-        with:
-          message: '[auto] build: update input typings'
-          add: src/inputs.ts
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/docs.yml

@@ -1,6 +1,8 @@
 name: Docs
 on:
   push:
+    branches:
+      - master
     paths:
       - .all-contributorsrc
       - .github/workflows/docs.yml
@@ -23,7 +25,7 @@ jobs:
 
       - uses: EndBug/add-and-commit@v4.0.0
         with:
-          message: "[auto] docs: update contributors badge"
+          message: '[auto] docs: update contributors badge'
           add: README.md
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/label-sync.yml

@@ -1,6 +1,8 @@
 name: Sync labels
 on:
   push:
+    branches:
+      - master
     paths:
       - '.github/labels.yml'
   workflow_dispatch:

.prettierrc

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

CHANGELOG.md

@@ -1,4 +1,5 @@
 # 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/),
@@ -6,125 +7,183 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
-## [5.2.0] - 2020-11-11
+## [5.3.0] - 2020-12-12
+
 ### 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)
+
+- 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) 
+
+- 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: 
+
+### 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: 
+
+### 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.2.0...HEAD
+
+[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
@@ -149,3 +208,4 @@ First release
 [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

README.md

@@ -1,4 +1,5 @@
 # Add & Commit
+
 <a href="https://github.com/search?o=desc&q=EndBug%2Fadd-and-commit+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code" target="_blank" title="Public workflows that use this action."><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3DEndBug%2Fadd-and-commit%26badge%3Dtrue" alt="Public workflows that use this action."></a>
 [![All Contributors](https://img.shields.io/badge/all_contributors-18-orange.svg?style=flat)](#contributors-)
 
@@ -48,7 +49,7 @@ Add a step like this to your workflow:
 
     # 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'
 
     # Whether to use the --signoff option on `git commit` (only `true` and `false` are accepted)
     # Default: false
@@ -56,7 +57,7 @@ Add a step like this to your workflow:
 
     # 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"
+    tag: 'v1.0.0 --force'
 
   env:
     # This is necessary in order to push a commit to the repo
@@ -82,6 +83,16 @@ The script will not stop if one of the git commands fails. E.g.: if your command
 
 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).
 
+### Outputs:
+
+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:
@@ -90,34 +101,34 @@ 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@v5
-      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@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.
@@ -126,7 +137,7 @@ If you need to run the action on a repository that is not located in [`$GITHUB_W
 name: Use a different repository directory
 on: push
 
-jobs: 
+jobs:
   run:
     name: Add a text file
     runs-on: ubuntu-latest
@@ -135,7 +146,7 @@ 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
@@ -143,9 +154,9 @@ jobs:
       # ...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/"
+          message: 'Add the very useful text file'
+          add: '*.txt --force'
+          cwd: './pathToRepo/'
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
@@ -186,6 +197,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 
 <!-- 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!

action.yml

@@ -39,6 +39,14 @@ inputs:
     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/index.js

package-lock.json

@@ -602,6 +602,24 @@
         }
       }
     },
+    "eslint-config-prettier": {
+      "version": "6.15.0",
+      "resolved": "https://registry.npmjs.org/eslint-config-prettier/-/eslint-config-prettier-6.15.0.tgz",
+      "integrity": "sha512-a1+kOYLR8wMGustcgAjdydMsQ2A/2ipRPwRKUmfYaSxc9ZPcrku080Ctl6zrZzZNs/U82MjSv+qKREkoq3bJaw==",
+      "dev": true,
+      "requires": {
+        "get-stdin": "^6.0.0"
+      }
+    },
+    "eslint-plugin-prettier": {
+      "version": "3.1.4",
+      "resolved": "https://registry.npmjs.org/eslint-plugin-prettier/-/eslint-plugin-prettier-3.1.4.tgz",
+      "integrity": "sha512-jZDa8z76klRqo+TdGDTFJSavwbnWK2ZpqGKNZ+VvweMW516pDUMmQ2koXvxEE4JhzNvTv+radye/bWGBmA6jmg==",
+      "dev": true,
+      "requires": {
+        "prettier-linter-helpers": "^1.0.0"
+      }
+    },
     "eslint-scope": {
       "version": "5.0.0",
       "resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.0.0.tgz",
@@ -691,6 +709,12 @@
       "integrity": "sha512-8UEa58QDLauDNfpbrX55Q9jrGHThw2ZMdOky5Gl1CDtVeJDPVrG4Jxx1N8jw2gkWaff5UUuX1KJd+9zGe2B+ZA==",
       "dev": true
     },
+    "fast-diff": {
+      "version": "1.2.0",
+      "resolved": "https://registry.npmjs.org/fast-diff/-/fast-diff-1.2.0.tgz",
+      "integrity": "sha512-xJuoT5+L99XlZ8twedaRf6Ax2TgQVxvgZOYoPKqZufmJib0tL2tegPBOZb1pVNgIhlqDlA0eO0c3wBvQcmzx4w==",
+      "dev": true
+    },
     "fast-json-stable-stringify": {
       "version": "2.1.0",
       "resolved": "https://registry.npmjs.org/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz",
@@ -780,6 +804,12 @@
       "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==",
       "dev": true
     },
+    "get-stdin": {
+      "version": "6.0.0",
+      "resolved": "https://registry.npmjs.org/get-stdin/-/get-stdin-6.0.0.tgz",
+      "integrity": "sha512-jp4tHawyV7+fkkSKyvjuLZswblUtz+SQKzSWnBbii16BuZksJlU1wuBYXY75r+duh/llF1ur6oNwi+2ZzjKZ7g==",
+      "dev": true
+    },
     "glob": {
       "version": "7.1.6",
       "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz",
@@ -1387,6 +1417,21 @@
       "integrity": "sha1-IZMqVJ9eUv/ZqCf1cOBL5iqX2lQ=",
       "dev": true
     },
+    "prettier": {
+      "version": "2.2.1",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.2.1.tgz",
+      "integrity": "sha512-PqyhM2yCjg/oKkFPtTGUojv7gnZAoG80ttl45O6x2Ug/rMJw4wcc9k6aaf2hibP7BGVCCM33gZoGjyvt9mm16Q==",
+      "dev": true
+    },
+    "prettier-linter-helpers": {
+      "version": "1.0.0",
+      "resolved": "https://registry.npmjs.org/prettier-linter-helpers/-/prettier-linter-helpers-1.0.0.tgz",
+      "integrity": "sha512-GbK2cP9nraSSUF9N2XwUwqfzlAFlMNYYl+ShE/V+H8a9uNl/oUqB1w2EL54Jh0OlyRSd8RfWYJ3coVS4TROP2w==",
+      "dev": true,
+      "requires": {
+        "fast-diff": "^1.1.2"
+      }
+    },
     "progress": {
       "version": "2.0.3",
       "resolved": "https://registry.npmjs.org/progress/-/progress-2.0.3.tgz",
@@ -1518,13 +1563,23 @@
       "dev": true
     },
     "simple-git": {
-      "version": "2.21.0",
-      "resolved": "https://registry.npmjs.org/simple-git/-/simple-git-2.21.0.tgz",
-      "integrity": "sha512-rohCHmEjD/ESXFLxF4bVeqgdb4Awc65ZyyuCKl3f7BvgMbZOBa/Ye3HN/GFnvruiUOAWWNupxhz3Rz5/3vJLTg==",
+      "version": "2.23.0",
+      "resolved": "https://registry.npmjs.org/simple-git/-/simple-git-2.23.0.tgz",
+      "integrity": "sha512-s/gEkxFV2WGTN4kO1uQoA4cE4rq0FRzQPR5Yhgg8JUuA4IhOeccjlKSFhwF3rrpo7797ZvQc7L6hJJNA4szHCw==",
       "requires": {
         "@kwsites/file-exists": "^1.1.1",
         "@kwsites/promise-deferred": "^1.1.1",
-        "debug": "^4.1.1"
+        "debug": "^4.3.1"
+      },
+      "dependencies": {
+        "debug": {
+          "version": "4.3.1",
+          "resolved": "https://registry.npmjs.org/debug/-/debug-4.3.1.tgz",
+          "integrity": "sha512-doEwdvm4PCeK4K3RQN2ZC2BYUBaxwLARCqZmMjtF8a51J2Rb0xpVloFRnCODwqjpwnAoao4pelN8l3RJdv3gRQ==",
+          "requires": {
+            "ms": "2.1.2"
+          }
+        }
       }
     },
     "slash": {
@@ -1730,9 +1785,9 @@
       "dev": true
     },
     "typescript": {
-      "version": "4.0.5",
-      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.0.5.tgz",
-      "integrity": "sha512-ywmr/VrTVCmNTJ6iV2LwIrfG1P+lv6luD8sUJs+2eI9NLGigaN+nUQc13iHqisq7bra9lnmUSYqbJvegraBOPQ==",
+      "version": "4.1.2",
+      "resolved": "https://registry.npmjs.org/typescript/-/typescript-4.1.2.tgz",
+      "integrity": "sha512-thGloWsGH3SOxv1SoY7QojKi0tc+8FnOmiarEGMbd/lar7QOEd3hvlx3Fp5y6FlDUGl9L+pd4n2e+oToGMmhRQ==",
       "dev": true
     },
     "uri-js": {

package.json

@@ -1,19 +1,19 @@
 {
   "name": "add-and-commit",
-  "version": "5.2.0",
+  "version": "5.3.0",
   "description": "Add & commit files from a path directly from GitHub Actions",
   "main": "lib/index.js",
   "scripts": {
-    "build": "npm run inputs && 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:fix": "eslint --ext .ts --fix src",
     "all-contributors-badge": "ts-node scripts/all-contributors-badge",
     "changelog": "ts-node scripts/changelog.ts",
-    "inputs": "ts-node scripts/inputs.ts",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "husky": {
     "hooks": {
-      "pre-commit": "npm run build && git add src lib"
+      "pre-commit": "npm run build && git add lib"
     }
   },
   "repository": {
@@ -36,7 +36,7 @@
   "dependencies": {
     "@actions/core": "^1.2.6",
     "axios": "^0.21.0",
-    "simple-git": "^2.21.0"
+    "simple-git": "2.23.0"
   },
   "devDependencies": {
     "@types/node": "^12.12.54",
@@ -46,9 +46,12 @@
     "@vercel/ncc": "^0.25.1",
     "all-contributors-cli": "^6.19.0",
     "eslint": "^6.8.0",
+    "eslint-config-prettier": "^6.15.0",
+    "eslint-plugin-prettier": "^3.1.4",
     "husky": "^4.3.0",
+    "prettier": "^2.2.1",
     "ts-node": "^9.0.0",
-    "typescript": "^4.0.5",
+    "typescript": "^4.1.2",
     "yamljs": "^0.3.0"
   }
 }

scripts/all-contributors-badge.ts

@@ -6,15 +6,19 @@ function path(...segments: string[]) {
 }
 
 const README = fs.readFileSync(path('README.md'), { encoding: 'utf8' }),
-  { contributors } = JSON.parse(fs.readFileSync(path('.all-contributorsrc'), { 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-')
+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')
+  )
+  .join('\n')
 
 fs.writeFileSync(path('README.md'), updatedREADME)

scripts/changelog.ts

@@ -2,7 +2,7 @@ import fs from 'fs'
 import path from 'path'
 
 const currentVersion = require('../package.json').version
-if (!currentVersion) throw new Error('Cant\'t detect library 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' })
@@ -12,7 +12,8 @@ let futureChangelog = ''
 
 // Add version section
 let arr = changelog.split('## [Unreleased]')
-arr[1] = `
+arr[1] =
+  `
 
 ## [${currentVersion}] - ${new Date().toISOString().slice(0, 10)}
 ### Removed:
@@ -28,13 +29,15 @@ 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)
+  .map((line) =>
+    line.startsWith('[Unreleased]')
+      ? `[Unreleased]: https://github.com/EndBug/add-and-commit/compare/v${currentVersion}...HEAD`
+      : line
+  )
 
-// eslint-disable-next-line no-useless-escape
-const lastVersion = ([...arr].reverse()[1]?.match(/\[([^\][]*)]/) || [])[0].replace(/[\[\]']+/g, '')
-if (!lastVersion) throw new Error('Can\'t find last version in changelog.')
+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

scripts/inputs.ts

@@ -1,11 +0,0 @@
-import YAML from 'yamljs'
-import fs from 'fs'
-
-const actionManifest = YAML.load('action.yml'),
-  inputs = Object.keys(actionManifest?.inputs || {})
-
-fs.writeFileSync('src/inputs.ts', `
-// WARNING: this file is auto-generated by scripts/inputs.ts (npm run inputs), any manual edit will be overwritten.
-
-export type Input = ${inputs.map(s => `'${s}'`).join(' | ')}
-`.trimLeft())

src/inputs.ts

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

src/main.ts

@@ -1,15 +1,20 @@
-import { info, setFailed, getInput as getInputCore, warning, debug, startGroup, endGroup, error } from '@actions/core'
+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 { Input } from './inputs'
+import { getInput, Input, log, outputs, parseBool, setOutput } from './util'
 
 const baseDir = path.join(process.cwd(), getInput('cwd') || '')
 const git = simpleGit({ baseDir })
-console.log(`Running in ${baseDir}`);
-
-(async () => {
+console.log(`Running in ${baseDir}`)
+;(async () => {
   await checkInputs().catch(setFailed)
 
   startGroup('Internal logs')
@@ -33,7 +38,10 @@ console.log(`Running in ${baseDir}`);
     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))
+    debug(
+      '> Current git config\n' +
+        JSON.stringify((await git.listConfig()).all, null, 2)
+    )
 
     await git.fetch(['--tags', '--force'], log)
 
@@ -43,44 +51,86 @@ console.log(`Running in ${baseDir}`);
       .catch(() => git.checkoutLocalBranch(getInput('branch'), log))
 
     info('> Pulling from remote...')
-    await git
-      .fetch(undefined, log)
-      .pull(undefined, undefined, {
+    await git.fetch(undefined, log).pull(
+      undefined,
+      undefined,
+      {
         [getInput('pull_strategy')]: null
-      }, log)
+      },
+      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
-      } : {})
-    }, log)
+    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(' '), log)
+      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 }, log)
+      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', (e, d?) => log(undefined, e || d)).catch(() => {
-          info('> Tag push failed: deleting remote tag and re-pushing...')
-          return git.push(undefined, undefined, {
-            '--delete': null,
-            'origin': null,
-            [getInput('tag').split(' ').filter(w => !w.startsWith('-'))[0]]: null
-          }, log)
-            .pushTags('origin', log)
-        })
+        await git
+          .pushTags('origin', (e, d?) => log(undefined, e || d))
+          .catch(() => {
+            info('> Tag push failed: deleting remote tag and re-pushing...')
+            return git
+              .push(
+                undefined,
+                undefined,
+                {
+                  '--delete': null,
+                  origin: null,
+                  [getInput('tag')
+                    .split(' ')
+                    .filter((w) => !w.startsWith('-'))[0]]: null
+                },
+                log
+              )
+              .pushTags('origin', log)
+          })
       } else info('> No tags to push.')
     } else info('> Not pushing anything.')
 
@@ -90,14 +140,17 @@ console.log(`Running in ${baseDir}`);
     endGroup()
     info('> Working tree clean. Nothing to commit.')
   }
-})().catch(e => {
-  endGroup()
-  setFailed(e)
-})
+})()
+  .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
+    if (value) return (process.env[`INPUT_${input.toUpperCase()}`] = value)
     else return delete process.env[`INPUT_${input.toUpperCase()}`]
   }
   function setDefault(input: Input, value: string) {
@@ -111,34 +164,45 @@ async function checkInputs() {
     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
+      ? (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.')
+  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.')
+    throw new Error(
+      "Both 'add' and 'remove' are empty, the action has nothing to do."
+    )
   // #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...')
+    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
+      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
   }
@@ -152,22 +216,29 @@ async function checkInputs() {
     const reason = !eventPath
       ? 'event path'
       : isPR
-        ? sha
-          ? 'fetch commit'
-          : 'find commit sha'
-        : !event?.head_commit
-          ? 'find commit'
-          : 'find commit author'
+      ? 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.`)
+  info(
+    `> Using '${getInput('author_name')} <${getInput(
+      'author_email'
+    )}>' as author.`
+  )
   // #endregion
 
   // #region message
-  setDefault('message', `Commit from GitHub Actions (${process.env.GITHUB_WORKFLOW})`)
+  setDefault(
+    'message',
+    `Commit from GitHub Actions (${process.env.GITHUB_WORKFLOW})`
+  )
   info(`> Using "${getInput('message')}" as commit message.`)
   // #endregion
 
@@ -181,65 +252,88 @@ async function checkInputs() {
     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.`)
+      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)
+    if (!parsed) setInput('signoff', undefined)
 
-    debug(`Current signoff option: ${getInput('signoff')} (${typeof getInput('signoff')})`)
+    debug(
+      `Current signoff option: ${getInput('signoff')} (${typeof getInput(
+        'signoff'
+      )})`
+    )
   }
 
-  // #endregion  
+  // #endregion
 
   // #region push
   setDefault('push', 'true')
-  if (getInput('push')) { // It's just to scope the parsed constant
+  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.`)
+      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)
+    if (!parsed) setInput('push', undefined)
 
-    debug(`Current push option: ${getInput('push')} (${typeof getInput('push')})`)
+    debug(
+      `Current push option: ${getInput('push')} (${typeof getInput('push')})`
+    )
   }
   // #endregion
 }
-
-function getInput(name: Input) {
-  return getInputCore(name)
-}
-
-function parseBool(value: any) {
-  try {
-    const parsed = JSON.parse(value)
-    if (typeof parsed == 'boolean')
-      return parsed
-  } catch { }
-}
-
-function log(err: any | Error, data?: any) {
-  if (data) console.log(data)
-  if (err) error(err)
-}
-
-function add({ logWarning = true, ignoreErrors = false } = {}): Promise<void | Response<void>> | void {
+function add({
+  logWarning = true,
+  ignoreErrors = false
+} = {}): Promise<void | Response<void>> | void {
   if (getInput('add'))
-    return git.add(getInput('add').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('Add command did not match any file.')
-      else throw e
-    })
+    return git
+      .add(getInput('add').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('Add command did not match any file.')
+        else throw e
+      })
 }
 
-function remove({ logWarning = true, ignoreErrors = false } = {}): Promise<void | Response<void>> | void {
+function remove({
+  logWarning = true,
+  ignoreErrors = false
+} = {}): Promise<void | Response<void>> | void {
   if (getInput('remove'))
-    return git.rm(getInput('remove').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.')
-      else throw e
-    })
+    return git
+      .rm(getInput('remove').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.')
+        else throw e
+      })
+}
+
+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])