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

@@ -120,6 +120,24 @@
       "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,

README.md

@@ -1,6 +1,6 @@
 # Add & Commit
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-[![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors-)
+[![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....
@@ -35,6 +35,10 @@ 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'
@@ -168,6 +172,8 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
     <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>
 

action.yml

@@ -20,6 +20,10 @@ 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

lib/entrypoint.sh

@@ -31,6 +31,11 @@ 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
 }
@@ -47,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 "$INPUT_REF"; then
-        echo "Creating branch..."
-        git branch "$INPUT_REF"
-    fi
-
-    # Switch to branch from current workflow run
-    echo "Switching branch..."
-    git checkout "$INPUT_REF"
+    # 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
@@ -70,7 +69,7 @@ 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 "Tagging commit..."
     tag

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "add-and-commit",
-  "version": "4.2.0",
+  "version": "4.4.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -342,6 +342,14 @@
       "integrity": "sha512-3YDiu347mtVtjpyV3u5kVqQLP242c06zwDOgpeRnybmXlYYsLbtTrUBUm8i8srONt+FWobl5aibnU1030PeeuA==",
       "dev": true
     },
+    "axios": {
+      "version": "0.19.2",
+      "resolved": "https://registry.npmjs.org/axios/-/axios-0.19.2.tgz",
+      "integrity": "sha512-fjgm5MvRHLhx+osE2xoekY70AhARk3a6hkN+3Io1jc00jtquGvxYlKlsFUhmUET0V5te6CcZI7lcv2Ym61mjHA==",
+      "requires": {
+        "follow-redirects": "1.5.10"
+      }
+    },
     "balanced-match": {
       "version": "1.0.0",
       "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz",
@@ -798,6 +806,29 @@
       "integrity": "sha512-a1hQMktqW9Nmqr5aktAux3JMNqaucxGcjtjWnZLHX7yyPCmlSV3M54nGYbqT8K+0GhF3NBgmJCc3ma+WOgX8Jg==",
       "dev": true
     },
+    "follow-redirects": {
+      "version": "1.5.10",
+      "resolved": "https://registry.npmjs.org/follow-redirects/-/follow-redirects-1.5.10.tgz",
+      "integrity": "sha512-0V5l4Cizzvqt5D44aTXbFZz+FtyXV1vrDN6qrelxtfYQKW0KO0W2T/hkE8xvGa/540LkZlkaUjO4ailYTFtHVQ==",
+      "requires": {
+        "debug": "=3.1.0"
+      },
+      "dependencies": {
+        "debug": {
+          "version": "3.1.0",
+          "resolved": "https://registry.npmjs.org/debug/-/debug-3.1.0.tgz",
+          "integrity": "sha512-OX8XqP7/1a9cqkxYw2yXss15f26NKWBpDXQd0/uK/KPqdQhxbPa994hnzjcE2VqQpDslf55723cKPUOGSmMY3g==",
+          "requires": {
+            "ms": "2.0.0"
+          }
+        },
+        "ms": {
+          "version": "2.0.0",
+          "resolved": "https://registry.npmjs.org/ms/-/ms-2.0.0.tgz",
+          "integrity": "sha1-VgiurfwAvmwpAd9fmGF4jeDVl8g="
+        }
+      }
+    },
     "forever-agent": {
       "version": "0.6.1",
       "resolved": "https://registry.npmjs.org/forever-agent/-/forever-agent-0.6.1.tgz",

package.json

@@ -1,6 +1,6 @@
 {
   "name": "add-and-commit",
-  "version": "4.2.0",
+  "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",

src/entrypoint.sh

@@ -31,6 +31,11 @@ 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
 }
@@ -47,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 "$INPUT_REF"; then
-        echo "Creating branch..."
-        git branch "$INPUT_REF"
-    fi
-
-    # Switch to branch from current workflow run
-    echo "Switching branch..."
-    git checkout "$INPUT_REF"
+    # 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
@@ -70,7 +69,7 @@ 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 "Tagging commit..."
     tag

src/main.ts

@@ -1,36 +1,68 @@
 import { info, setFailed, getInput, warning } from '@actions/core'
 import { execFile } from 'child_process'
-import { join } from 'path'
+import path from 'path'
+import axios from 'axios'
 
-try {
-  checkInputs()
-  const child = execFile(join(__dirname, 'entrypoint.sh'), [], { shell: true })
+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')
   }
 
-  setDefault('ref', process.env.GITHUB_REF?.substring(11) || '')
-
   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
 }