Merge pull request #745 from wagoid/feat/use-only-github-api-to-list-commits

feat!: use github event payload and API to list commits

Author: wagoid

.github/workflows/ci.yml

@@ -36,8 +36,6 @@ jobs:
       DOCKER_REGISTRY_URL: registry.hub.docker.com
     steps:
       - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
       - uses: actions/setup-node@v3
         with:
           node-version: '16.5.0'

.github/workflows/commitlint.yml

@@ -6,8 +6,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
       - run: sed -i -E "s/(docker:.+)/Dockerfile/" ./action.yml
       - run: echo -n '' > .dockerignore
       - uses: actions/setup-node@v3
@@ -33,8 +31,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
       - uses: actions/setup-node@v3
         with:
           node-version: '16.5.0'

README.md

@@ -15,15 +15,11 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
       - uses: wagoid/commitlint-github-action@v5
 ```
 
 Alternatively, you can run on other event types such as `on: [push]`. In that case the action will lint the push event's commit(s) instead of linting commits from a pull request. You can also combine `push` and `pull_request` together in the same workflow.
 
-**Note**: It's necessary that you specify the `fetch-depth` argument to `actions/checkout@v2` step. By default they fetch only latest commit of the branch, but we need more commits since we validate a range of commit messages.
-
 ## Inputs
 
 You can supply these inputs to the `wagoid/commitlint-github-action@v5` step.
@@ -38,14 +34,6 @@ If the config file doesn't exist, [config-conventional](https://github.com/conve
 
 Details on the configuration file can be found on [the commitlint website](https://commitlint.js.org/#/reference-configuration).
 
-### `firstParent`
-
-When set to true, we follow only the first parent commit when seeing a merge commit.
-
-This helps to ignore errors in commits that were already present in your default branch (e.g. `master`) before adding conventional commit checks. More info in [git-log docs](https://git-scm.com/docs/git-log#Documentation/git-log.txt---first-parent).
-
-Default: `true`
-
 ### `failOnWarnings`
 
 Whether you want to fail on warnings or not.
@@ -147,8 +135,6 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-        with:
-          fetch-depth: 0
       - uses: actions/setup-node@v2
         with:
           node-version: '14'

action.yml

@@ -3,32 +3,26 @@ description: Lints Pull Request commit messages with commitlint
 author: Wagner Santos
 inputs:
   configFile:
-    description: Commitlint config file. If the file doesn't exist, config-conventional settings will be
+    description:
+      Commitlint config file. If the file doesn't exist, config-conventional settings will be
       loaded as a fallback.
     default: ./commitlint.config.js
     required: false
-  firstParent:
-    description: >
-      When set to true, we follow only the first parent commit when seeing a merge commit.
-      More info in git-log docs
-      https://git-scm.com/docs/git-log#Documentation/git-log.txt---first-parent
-    default: "true"
-    required: false
   failOnWarnings:
     description: Whether you want to fail on warnings or not
-    default: "false"
+    default: 'false'
     required: false
   failOnErrors:
     description: Whether you want to fail on errors or not
-    default: "true"
+    default: 'true'
     required: true
   helpURL:
     description: Link to a page explaining your commit message convention
     default: https://github.com/conventional-changelog/commitlint/#what-is-commitlint
     required: false
   commitDepth:
     description: When set to a valid Integer value - X, considers only the latest X number of commits.
-    default: ""
+    default: ''
     required: false
   token:
     description: >

package-lock.json

@@ -38,7 +38,6 @@
     "conventional-changelog-conventionalcommits": "^4.6.3",
     "conventional-changelog-lint-config-canonical": "^1.0.0",
     "dargs": "^8.1.0",
-    "execa": "^5.1.1",
     "lerna": "^5.1.4"
   },
   "devDependencies": {

package.json

@@ -5,14 +5,13 @@ import { context as eventContext, getOctokit } from '@actions/github'
 import lint from '@commitlint/lint'
 import { format } from '@commitlint/format'
 import load from '@commitlint/load'
-import gitCommits from './gitCommits'
 import generateOutputs from './generateOutputs'
 
 const pullRequestEvent = 'pull_request'
 const pullRequestTargetEvent = 'pull_request_target'
 const pullRequestEvents = [pullRequestEvent, pullRequestTargetEvent]
 
-const { GITHUB_EVENT_NAME, GITHUB_SHA } = process.env
+const { GITHUB_EVENT_NAME } = process.env
 
 const configPath = resolve(process.env.GITHUB_WORKSPACE, getInput('configFile'))
 
@@ -23,66 +22,32 @@ const getCommitDepth = () => {
   return Number.isNaN(commitDepth) ? null : Math.max(commitDepth, 0)
 }
 
-const pushEventHasOnlyOneCommit = (from) => {
-  const gitEmptySha = '0000000000000000000000000000000000000000'
+const getPushEventCommits = () => {
+  const mappedCommits = eventContext.payload.commits.map((commit) => ({
+    message: commit.message,
+    hash: commit.id,
+  }))
 
-  return from === gitEmptySha
+  return mappedCommits
 }
 
-const getRangeForPushEvent = () => {
-  let from = eventContext.payload.before
-  const to = GITHUB_SHA
-
-  if (eventContext.payload.forced) {
-    // When a commit is forced, "before" field from the push event data may point to a commit that doesn't exist
-    console.warn(
-      'Commit was forced, checking only the latest commit from push instead of a range of commit messages',
-    )
-    from = null
-  }
-
-  if (pushEventHasOnlyOneCommit(from)) {
-    from = null
-  }
-
-  return [from, to]
-}
-
-const getRangeForEvent = async () => {
+const getEventCommits = async () => {
   if (!pullRequestEvents.includes(GITHUB_EVENT_NAME))
-    return getRangeForPushEvent()
+    return getPushEventCommits()
 
   const octokit = getOctokit(getInput('token'))
   const { owner, repo, number } = eventContext.issue
   const { data: commits } = await octokit.rest.pulls.listCommits({
     owner,
     repo,
     pull_number: number,
+    per_page: 100,
   })
-  const commitShas = commits.map((commit) => commit.sha)
-  const [from] = commitShas
-  const to = commitShas[commitShas.length - 1]
-  // Git revision range doesn't include the "from" field in "git log", so for "from" we use the parent commit of PR's first commit
-  const fromParent = `${from}^1`
-
-  return [fromParent, to]
-}
-
-function getHistoryCommits(from, to) {
-  const options = {
-    from,
-    to,
-  }
-
-  if (getInput('firstParent') === 'true') {
-    options.firstParent = true
-  }
-
-  if (!from) {
-    options.maxCount = 1
-  }
 
-  return gitCommits(options)
+  return commits.map((commit) => ({
+    message: commit.commit.message,
+    hash: commit.sha,
+  }))
 }
 
 function getOptsFromConfig(config) {
@@ -124,8 +89,8 @@ const handleOnlyWarnings = (formattedResults) => {
   }
 }
 
-const showLintResults = async ([from, to]) => {
-  let commits = await getHistoryCommits(from, to)
+const showLintResults = async (eventCommits) => {
+  let commits = eventCommits
   const commitDepth = getCommitDepth()
   if (commitDepth) {
     commits = commits?.slice(0, commitDepth)
@@ -163,7 +128,7 @@ const exitWithMessage = (message) => (error) => {
 }
 
 const commitLinterAction = () =>
-  getRangeForEvent()
+  getEventCommits()
     .catch(
       exitWithMessage("error trying to get list of pull request's commits"),
     )