chore(docs): switch to dynamic all-contributors badge

* 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

@@ -145,7 +145,8 @@
       "avatar_url": "https://avatars1.githubusercontent.com/u/8356175?v=4",
       "profile": "https://github.com/Cyberbeni",
       "contributions": [
-        "ideas"
+        "ideas",
+        "code"
       ]
     },
     {
@@ -192,6 +193,15 @@
       "contributions": [
         "ideas"
       ]
+    },
+    {
+      "login": "PssbleTrngle",
+      "name": "Possible Triangle",
+      "avatar_url": "https://avatars1.githubusercontent.com/u/12880806?v=4",
+      "profile": "https://www.somethingcatchy.net",
+      "contributions": [
+        "ideas"
+      ]
     }
   ],
   "contributorsPerLine": 7,

.github/workflows/docs.yml

@@ -1,31 +0,0 @@
-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/test.yml

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

CHANGELOG.md

@@ -7,6 +7,22 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [6.2.0] - 2020-12-23
+
+### Added:
+
+- `push` input: allow for custom `git push` arguments to be used, more info in the README. (issue #100)
+
+## [6.1.0] - 2020-12-22
+
+### Added:
+
+- `token` input: you can now use this instead of setting the `GITHUB_TOKEN` env variable, which has been deprecated. This input is optional, its default value is the default `secrets.GITHUB_TOKEN`. You only need to use this if you want the action to run with a PAT. (issue #110)
+
+### Deprecated:
+
+- `GITHUB_TOKEN`: the use of this env variable is now deprecated in favor of the `token` input, you'll start receiving warnings if you keep using it. (issue #110)
+
 ## [6.0.0] - 2020-12-22
 
 ### Added:
@@ -189,7 +205,7 @@ First release
 
 #
 
-[unreleased]: https://github.com/EndBug/add-and-commit/compare/v5.3.0...HEAD
+[unreleased]: https://github.com/EndBug/add-and-commit/compare/v6.2.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
@@ -216,3 +232,5 @@ First release
 [5.2.0]: https://github.com/EndBug/add-and-commit/compare/v5.1.2...v5.2.0
 [5.3.0]: https://github.com/EndBug/add-and-commit/compare/v5.2.0...v5.3.0
 [6.0.0]: https://github.com/EndBug/add-and-commit/compare/v5.3.0...v6.0.0
+[6.1.0]: https://github.com/EndBug/add-and-commit/compare/v6.0.0...v6.1.0
+[6.2.0]: https://github.com/EndBug/add-and-commit/compare/v6.1.0...v6.2.0

README.md

@@ -1,7 +1,7 @@
 # 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-20-orange.svg?style=flat)](#contributors-)
+[![Public workflows that use this action.](https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3DEndBug%2Fadd-and-commit%26badge%3Dtrue)](https://github.com/search?o=desc&q=EndBug+add-and-commit+path%3A.github%2Fworkflows+language%3AYAML&s=&type=Code)
+[![All Contributors](https://img.shields.io/github/all-contributors/EndBug/add-and-commit)](#contributors-)
 
 You can use this GitHub Action to commit changes made in your workflow run directly to your repo: for example, you use it to lint your code, update documentation, commit updated builds, etc....
 
@@ -13,7 +13,7 @@ This action lets you choose the path that you want to use when adding & committi
 Add a step like this to your workflow:
 
 ```yaml
-- uses: EndBug/add-and-commit@v5 # You can change this to use a specific version
+- uses: EndBug/add-and-commit@v6 # 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: '.'
@@ -43,7 +43,7 @@ Add a step like this to your workflow:
     # 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)
+    # Whether to push the commit and, if any, its tags to the repo. It can also be used to set the git push arguments (see the paragraph below for more info)
     # Default: true
     push: false
 
@@ -59,16 +59,11 @@ Add a step like this to your workflow:
     # 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
+    # Token to use for pushing the commit. The default value won't trigger any workflows, you need to use a Personal Access Token for that.
+    # Default: secrets.GITHUB_TOKEN
+    token: ${{ secrets.GITHUB_TOKEN }}
 ```
 
-### 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).  
-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`.  
@@ -81,6 +76,17 @@ You can delete files with the `remove` option: that runs a `git rm` command that
 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.
 
+### Pushing:
+
+By default the action runs the following command: `git push origin ${branch input} --set-upstream`. You can use the `push` input to modify this behavior, here's what you can set it to:
+
+- `true`: this is the default value, it will behave as usual.
+- `false`: this prevents the action from pushing at all, no `git push` command is run.
+- any other string:  
+  The action will use your string as the arguments for the `git push` command. Please note that nothing is used other than your arguments, and the command will result in `git push ${push input}` (no remote, no branch, no `--set-upstream`, you have to include them yourself).
+
+One way to use this is if you want to force push to a branch of your repo: you'll need to set the `push` input to, for example, `origin yourBranch --force`.
+
 ### Tagging:
 
 You can use the `tag` option to enter the arguments for a `git add` command. In order for the action to isolate the tag name from the rest of the arguments, it should be the first word not preceded by an hyphen (e.g. `-a tag-name -m "some other stuff"` is ok).
@@ -123,14 +129,12 @@ jobs:
         run: eslint "src/**" --fix
 
       - name: Commit changes
-        uses: EndBug/add-and-commit@v5
+        uses: EndBug/add-and-commit@v6
         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.
@@ -154,13 +158,11 @@ jobs:
       - 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
+      - uses: EndBug/add-and-commit@v6
         with:
           message: 'Add the very useful text file'
           add: '*.txt --force'
           cwd: './pathToRepo/'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
 
 ## Contributors ✨
@@ -190,12 +192,13 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <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/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> <a href="https://github.com/EndBug/add-and-commit/commits?author=Cyberbeni" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/coffeegoddd"><img src="https://avatars3.githubusercontent.com/u/43383835?v=4" 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>
+    <td align="center"><a href="https://www.somethingcatchy.net"><img src="https://avatars1.githubusercontent.com/u/12880806?v=4" width="100px;" alt=""/><br /><sub><b>Possible Triangle</b></sub></a><br /><a href="#ideas-PssbleTrngle" title="Ideas, Planning, & Feedback">🤔</a></td>
   </tr>
 </table>
 

action.yml

@@ -27,8 +27,9 @@ inputs:
     required: false
     default: '--no-rebase'
   push:
-    description: Whether to push the commit and, if any, its tags to the repo
+    description: Whether to push the commit and, if any, its tags to the repo. It can also be used to set the git push arguments (more info in the README)
     required: false
+    default: 'true'
   remove:
     description: Arguments for the git rm command
     required: false
@@ -38,6 +39,10 @@ inputs:
   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
+  token:
+    description: 'GITHUB_TOKEN or a `repo` scoped Personal Access Token (PAT)'
+    required: false
+    default: ${{ github.token }}
 
 outputs:
   committed:

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "add-and-commit",
-  "version": "5.3.0",
+  "version": "6.2.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

package.json

@@ -1,14 +1,14 @@
 {
   "name": "add-and-commit",
-  "version": "6.0.0",
+  "version": "6.2.0",
   "description": "Add & commit files from a path directly from GitHub Actions",
   "main": "lib/index.js",
   "scripts": {
     "build": "ncc build src/main.ts --minify --out lib",
     "watch": "ncc build src/main.ts --watch --out lib",
+    "lint": "eslint --ext .ts src",
     "lint:fix": "eslint --ext .ts --fix src",
-    "all-contributors-badge": "ts-node scripts/all-contributors-badge",
-    "changelog": "ts-node scripts/changelog.ts",
+    "changelog": "ts-node scripts/changelog.ts && npm i",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "husky": {

scripts/all-contributors-badge.ts

@@ -1,24 +0,0 @@
-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

@@ -27,13 +27,11 @@ 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
-  )
+arr = futureChangelog.split('\n').map((line) =>
+  line.startsWith('[unreleased]') // The link ref is lowercase because of prettier
+    ? `[unreleased]: https://github.com/EndBug/add-and-commit/compare/v${currentVersion}...HEAD`
+    : line
+)
 
 const lastVersion = ([...arr].reverse()[1]?.match(/\[([^\][]*)]/) ||
   [])[0].replace(/[\[\]']+/g, '') // eslint-disable-line no-useless-escape

src/main.ts

@@ -99,17 +99,34 @@ console.log(`Running in ${baseDir}`)
         .catch((err) => setFailed(err))
     } else info('> No tag info provided.')
 
-    if (getInput('push')) {
+    const pushOption = parseBool(getInput('push')) ?? getInput('push')
+    if (pushOption) {
+      // If the options is `true | string`...
       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 (pushOption === true) {
+        debug(`Running: git push origin ${getInput('branch')} --set-upstream`)
+        await git.push(
+          'origin',
+          getInput('branch'),
+          { '--set-upstream': null },
+          (err, data?) => {
+            if (data) setOutput('pushed', 'true')
+            return log(err, data)
+          }
+        )
+      } else {
+        debug(`Running: git push ${pushOption}`)
+        await git.push(
+          undefined,
+          undefined,
+          pushOption.split(' '),
+          (err, data?) => {
+            if (data) setOutput('pushed', 'true')
+            return log(err, data)
+          }
+        )
+      }
 
       if (getInput('tag')) {
         info('> Pushing tags to repo...')
@@ -161,7 +178,6 @@ async function checkInputs() {
 
   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
@@ -169,10 +185,17 @@ async function checkInputs() {
       : process.env.GITHUB_REF?.substring(11)
 
   // #region GITHUB_TOKEN
-  if (!token)
+  let token = process.env.GITHUB_TOKEN
+  if (token) {
+    debug('Using token from GITHUB_TOKEN env variable.')
     warning(
-      'The GITHUB_TOKEN env variable is missing: the action may not work as expected.'
+      "The GITHUB_TOKEN env variable is deprecated and will not be supported in the next major release. Use the 'token' input, " +
+        "which defaults to 'secrets.GITHUB_TOKEN'."
     )
+  } else {
+    debug('Using token from token input.')
+    token = getInput('token')
+  }
   // #endregion
 
   // #region add, remove
@@ -288,26 +311,15 @@ async function checkInputs() {
       )})`
     )
   }
-
   // #endregion
 
   // #region push
-  setDefault('push', 'true')
   if (getInput('push')) {
-    // It's just to scope the parsed constant
+    // It has to be either 'true', 'false', or any other string (use as arguments)
     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')})`
+      `Current push option: '${getInput('push')}' (parsed as ${typeof parsed})`
     )
   }
   // #endregion

src/util.ts

@@ -12,6 +12,7 @@ export type Input =
   | 'remove'
   | 'signoff'
   | 'tag'
+  | 'token'
 
 export const outputs = {
   committed: 'false',