release: v4.4.0

* docs: update README.md [skip ci]

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

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

.all-contributorsrc

@@ -0,0 +1,145 @@
+{
+  "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"
+      ]
+    }
+  ],
+  "contributorsPerLine": 7,
+  "skipCi": true
+}

.github/workflows/build.yml

@@ -29,7 +29,7 @@ jobs:
       - name: Commit changes
         uses: EndBug/add-and-commit@v4.0.0
         with:
-          message: "[auto] Update compiled version"
+          message: "[auto] build: update compiled version"
           add: lib
           force: true
         env:

.github/workflows/versioning.yml

@@ -8,7 +8,7 @@ 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:

README.md

@@ -1,4 +1,7 @@
 # Add & Commit
+<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+[![All Contributors](https://img.shields.io/badge/all_contributors-14-orange.svg?style=flat-square)](#contributors-)
+<!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 You can use this GitHub Action to commit changes made in your workflow run directly to your repo: for example, you use it to lint your code, update documentation, commit updated builds, etc....
 
@@ -32,14 +35,26 @@ Add a step like this to your workflow:
     # Default: false
     force: true
 
+    # Whether to use the --signoff option on `git commit`
+    # Default: false
+    signoff: true
+
     # The message for the commit
     # Default: 'Commit from GitHub Actions'
     message: 'Your commit message'
 
-    #  The arguments for the `git rm` command (see the paragraph below for more info)
+    # Name of the branch to use, if different from the one that triggered the workflow
+    # Default: the branch that triggered the workflow (from GITHUB_REF)
+    ref: 'someOtherBranch'
+
+    # The arguments for the `git rm` command (see the paragraph below for more info)
     # Default: ''
     remove: "./dir/old_file.js"
 
+    # Name of the tag to add to the new commit (see the paragraph below for more info)
+    # Default: ''
+    tag: "v1.0.0"
+
   env:
     # This is necessary in order to push a commit to the repo
     GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # Leave this line unchanged
@@ -60,6 +75,11 @@ The script will not stop if one of the git commands fails. E.g.: if your command
 You can delete files with the `remove` option: that runs a `git rm` command that will stage the files in the given path for removal. 
 The script will not stop if one of the git commands fails. E.g.: if your command shows a "fatal: pathspec 'yourFile' did not match any files" error the action will go on.
 
+### Tagging:
+
+You can tag commits with the `tag` option: when used, it will create a lightweight tag for the commit with the name you set as input. If not entered (or if an empty string is passed) teh action won't create any tag.  
+If there is already a tag with the name you entered it will be overwritten, and so the tag will be "updated".
+
 ### 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:
@@ -129,6 +149,40 @@ jobs:
           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>
+</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

@@ -20,14 +20,25 @@ inputs:
     description: Whether to use the force option on git add, in order to bypass eventual gitignores
     required: false
     default: "false"
+  signoff:
+    description: Whether to use the signoff option on git commit
+    required: false
+    default: "false"
   message:
     description: The message for the commit
     required: false
     default: Commit from GitHub Actions
+  ref:
+    description: Name of the branch to use, if different from the one that triggered the workflow
+    required: false
   remove:
     description: Arguments for the git rm command
     required: false
     default: ""
+  tag:
+    description: The name of the tag to add to the new commit
+    required: false
+    default: ""
 
 runs:
   using: node12

lib/entrypoint.sh

@@ -31,6 +31,15 @@ remove() {
     if [ -n "$INPUT_REMOVE" ]; then git rm $INPUT_REMOVE; fi
 }
 
+commit() {
+    if $INPUT_SIGNOFF; then signoffcmd=--signoff; else signoffcmd=; fi
+    git commit -m "$INPUT_MESSAGE" --author="$INPUT_AUTHOR_NAME <$INPUT_AUTHOR_EMAIL>" $signoffcmd
+}
+
+tag() {
+    if [ -n "$INPUT_TAG" ]; then git tag $INPUT_TAG; fi
+}
+
 # This is needed to make the check work for untracked files
 echo "Staging files..."
 add
@@ -43,15 +52,9 @@ if ! git diff --cached --quiet --exit-code; then
 
     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}"
+    # Switch branch (create a new one if it doesn't exist)
+    echo "Switching/creating branch..."
+    git checkout "$INPUT_REF" 2>/dev/null || git checkout -b "$INPUT_REF"
 
     echo "Pulling from remote..."
     git fetch && git pull
@@ -66,10 +69,16 @@ if ! git diff --cached --quiet --exit-code; then
     remove
 
     echo "Creating commit..."
-    git commit -m "$INPUT_MESSAGE" --author="$INPUT_AUTHOR_NAME <$INPUT_AUTHOR_EMAIL>"
+    commit
 
-    echo "Pushing to repo..."
-    git push --set-upstream origin "${GITHUB_REF:11}"
+    echo "Tagging commit..."
+    tag
+
+    echo "Pushing commits to repo..."
+    git push --set-upstream origin "$INPUT_REF"
+
+    echo "Pushing tags to repo..."
+    git push --set-upstream origin "$INPUT_REF" --force --tags
 
     echo "::endgroup::"
     echo "Task completed."

package.json

@@ -1,6 +1,6 @@
 {
   "name": "add-and-commit",
-  "version": "4.0.3",
+  "version": "4.4.0",
   "description": "Add & commit files from a path directly from GitHub Actions",
   "main": "lib/index.js",
   "scripts": {
@@ -26,7 +26,8 @@
   },
   "homepage": "https://github.com/EndBug/add-and-commit#readme",
   "dependencies": {
-    "@actions/core": "^1.1.3"
+    "@actions/core": "^1.1.3",
+    "axios": "^0.19.2"
   },
   "devDependencies": {
     "@types/node": "^12.7.12",
@@ -34,6 +35,7 @@
     "@typescript-eslint/eslint-plugin": "^2.12.0",
     "@typescript-eslint/parser": "^2.12.0",
     "@zeit/ncc": "^0.21.1",
+    "all-contributors-cli": "^6.16.1",
     "eslint": "^6.8.0",
     "typescript": "^3.6.4"
   }

src/entrypoint.sh

@@ -31,6 +31,15 @@ remove() {
     if [ -n "$INPUT_REMOVE" ]; then git rm $INPUT_REMOVE; fi
 }
 
+commit() {
+    if $INPUT_SIGNOFF; then signoffcmd=--signoff; else signoffcmd=; fi
+    git commit -m "$INPUT_MESSAGE" --author="$INPUT_AUTHOR_NAME <$INPUT_AUTHOR_EMAIL>" $signoffcmd
+}
+
+tag() {
+    if [ -n "$INPUT_TAG" ]; then git tag $INPUT_TAG; fi
+}
+
 # This is needed to make the check work for untracked files
 echo "Staging files..."
 add
@@ -43,15 +52,9 @@ if ! git diff --cached --quiet --exit-code; then
 
     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}"
+    # Switch branch (create a new one if it doesn't exist)
+    echo "Switching/creating branch..."
+    git checkout "$INPUT_REF" 2>/dev/null || git checkout -b "$INPUT_REF"
 
     echo "Pulling from remote..."
     git fetch && git pull
@@ -66,10 +69,16 @@ if ! git diff --cached --quiet --exit-code; then
     remove
 
     echo "Creating commit..."
-    git commit -m "$INPUT_MESSAGE" --author="$INPUT_AUTHOR_NAME <$INPUT_AUTHOR_EMAIL>"
+    commit
 
-    echo "Pushing to repo..."
-    git push --set-upstream origin "${GITHUB_REF:11}"
+    echo "Tagging commit..."
+    tag
+
+    echo "Pushing commits to repo..."
+    git push --set-upstream origin "$INPUT_REF"
+
+    echo "Pushing tags to repo..."
+    git push --set-upstream origin "$INPUT_REF" --force --tags
 
     echo "::endgroup::"
     echo "Task completed."

src/main.ts

@@ -1,34 +1,68 @@
 import { info, setFailed, getInput, warning } from '@actions/core'
-import { join as path } from 'path'
 import { execFile } from 'child_process'
+import path from 'path'
+import axios from 'axios'
 
-try {
-  checkInputs()
-  const child = execFile(path(__dirname, 'entrypoint.sh'))
+checkInputs().then(() => {
+  const child = execFile(path.join(__dirname, 'entrypoint.sh'), [], { shell: true })
   child.stdout?.pipe(process.stdout)
   child.stderr?.pipe(process.stderr)
-} catch (err) {
+}).catch(err => {
   console.error(err)
   setFailed(err instanceof Error ? err.message : err)
-}
+})
 
-function checkInputs() {
-  const eventPath = process.env.GITHUB_EVENT_PATH
-  const author = eventPath && require(eventPath)?.head_commit?.author
+async function checkInputs() {
+  const eventPath = process.env.GITHUB_EVENT_PATH,
+    event = eventPath && require(eventPath),
+    isPR = process.env.GITHUB_EVENT_NAME?.includes('pull_request'),
+    sha = (event?.pull_request?.head?.sha || process.env.GITHUB_SHA) as string,
+    defaultRef = isPR
+      ? event?.pull_request?.head?.ref as string
+      : process.env.GITHUB_REF?.substring(11)
+
+  const actualRef = setDefault('ref', defaultRef || '')
+
+  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 = process.env.GITHUB_TOKEN ? {
+        Authorization: `Bearer ${process.env.GITHUB_TOKEN}`
+      } : undefined,
+      commit = (await axios.get(url, { headers })).data
+
+    author = commit?.commit?.author
+  }
 
   if (author) {
     setDefault('author_name', author.name)
     setDefault('author_email', author.email)
-  } else {
-    if (!getInput('author_name') || !getInput('author_email')) warning(`Unable to fetch author info: couldn't find ${!eventPath ? 'event path' : !require(eventPath)?.head_commit ? 'commit' : 'commit author'}.`)
+  }
+
+  if (!getInput('author_name') || !getInput('author_email')) {
+    const reason = !eventPath
+      ? 'event path'
+      : isPR
+        ? sha
+          ? 'fetch commit'
+          : 'find commit sha'
+        : !event?.head_commit
+          ? 'find commit'
+          : 'find commit author'
+    warning(`Unable to fetch author info: couldn't ${reason}.`)
     setDefault('author_name', 'Add & Commit Action')
     setDefault('author_email', 'actions@github.com')
   }
 
   info(`Using '${getInput('author_name')} <${getInput('author_email')}>' as author.`)
+  if (isPR) info(`Running for a PR, the action will use '${actualRef}' as ref.`)
 }
 
 function setDefault(input: string, value: string) {
   const key = 'INPUT_' + input.toUpperCase()
   if (!process.env[key]) process.env[key] = value
+  return process.env[key] as string
 }