Merge pull request #8 from aschbacd/feature-support-push-events

Feature support push events

Author: aschbacd

README.md

@@ -13,15 +13,41 @@ Create the file `.github/workflows/linters.yaml` in your repository and add the
 name: Linters
 
 on:
-  pull_request:
+  pull_request: {}
+  push: {}
 
 jobs:
   gitlint:
     runs-on: ubuntu-latest
     name: GitLint
     steps:
       - name: Lint commits, branches, and pull requests
-        uses: aschbacd/[email protected]
+        uses: aschbacd/[email protected]
+```
+
+### Example configuration for Jira
+
+If you want to allow Jira issue ids at the beginning of the commit message / pull request title you
+can use the following configuration. With this configuration commit messages / pull request titles
+like `[GLA-1] Add sample file` as well as `Add sample file` will be valid.
+
+```yaml
+name: Linters
+
+on:
+  pull_request: {}
+  push: {}
+
+jobs:
+  gitlint:
+    runs-on: ubuntu-latest
+    name: GitLint
+    steps:
+      - name: Lint commits, branches, and pull requests
+        uses: aschbacd/[email protected]
+        with:
+          re-commit-message-subject: ^(\[[A-Z]+\-[0-9]+\] )?[A-Z].*((?!\.).)$
+          re-pull-request-title: ^(\[[A-Z]+\-[0-9]+\] )?[A-Z].*((?!\.).)$
 ```
 
 ## Customization
@@ -48,6 +74,7 @@ The following input keys can be used in your GitHub Actions workflow (shown abov
 | re-commit-message-split            | Regex used to split commit message subject and body (DotAll) | `([^\n]*)(?:\n\n(.*))?` |
 | re-commit-message-subject          | Regex used to check commit message subject                   | `^[A-Z].*((?!\\.).)$`   |
 | re-pull-request-title              | Regex used to check pull request title                       | `^[A-Z].*((?!\\.).)$`   |
+| re-tag-name                        | Regex used to check tag name                                 | `.*`                    |
 
 ## Resources
 

action.yml

@@ -76,6 +76,10 @@ inputs:
     description: "Regular expression to check pull request title"
     required: false
     default: "^[A-Z].*((?!\\.).)$"
+  re-tag-name:
+    description: "Regular expression to check tag name"
+    required: false
+    default: ".*"
 runs:
   using: "node12"
   main: "index.js"

index.js

@@ -12,17 +12,14 @@ async function run() {
     const githubToken = core.getInput('github-token')
     const octokit = github.getOctokit(githubToken)
 
-    // Get data
-    const { data: pullRequest } = await octokit.rest.pulls.get({
-      owner: github.context.payload.repository.owner.login,
-      repo: github.context.payload.repository.name,
-      pull_number: github.context.payload.pull_request.number
-    })
-    const { data: commits } = await octokit.rest.pulls.listCommits({
-      owner: github.context.payload.repository.owner.login,
-      repo: github.context.payload.repository.name,
-      pull_number: github.context.payload.pull_request.number
-    })
+    // Get context
+    const eventName = github.context.eventName
+    const payload = github.context.payload
+    const owner = payload.repository.owner.login
+    const repo = payload.repository.name
+
+    const ref = payload.ref
+    const pullRequest = payload.pull_request
 
     // -----
     // --------------- GET INPUT
@@ -47,21 +44,91 @@ async function run() {
     const regexCommitMessageSplit = RegExp(core.getInput('re-commit-message-split'), 's')
     const regexCommitMessageSubject = RegExp(core.getInput('re-commit-message-subject'))
     const regexPullRequestTitle = RegExp(core.getInput('re-pull-request-title'))
+    const regexTagName = RegExp(core.getInput('re-tag-name'))
+
+    // -----
+    // --------------- CHECK PULL REQUEST
+    // ----------
+
+    if (eventName === "pull_request") {
+      // Print pull request title
+      core.info(`Pull request title: ${pullRequest.title}`)      
+
+      // Check pull request title
+      if (!regexPullRequestTitle.test(pullRequest.title))
+        core.setFailed("Pull Request title does not match regex")
+    }
 
     // -----
-    // --------------- CHECK DATA
+    // --------------- CHECK BRANCH
     // ----------
 
-    core.info(`Pull request title: ${pullRequest.title}`)
-    core.info(`Branch name: ${pullRequest.head.ref}`)
+    // Get branch name
+    let branchName = ""
+    if (eventName === "pull_request") {
+      branchName = pullRequest.head.ref
+    } else if (eventName === "push" && ref.startsWith("refs/heads")) {
+      branchName = ref.replace("refs/heads/", "")
+    }
 
-    // Check pull request title
-    if (!regexPullRequestTitle.test(pullRequest.title))
-      core.setFailed("Pull Request title does not match regex")
+    if (branchName !== "") {
+      // Print branch name
+      core.info(`Branch name: ${branchName}`)
 
-    // Check branch name
-    if (!regexBranchName.test(pullRequest.head.ref))
-      core.setFailed("Branch name does not match regex")
+      // Check branch name
+      if (!regexBranchName.test(branchName))
+        core.setFailed("Branch name does not match regex")
+    }
+
+    // -----
+    // --------------- CHECK TAG
+    // ----------
+
+    if (eventName === "push" && ref.startsWith("refs/tags")) {
+      // Get tag name
+      const tagName = ref.replace("refs/tags/", "")
+
+      // Print tag name
+      core.info(`Tag name: ${tagName}`)
+
+      // Check tag name
+      if (!regexTagName.test(tagName))
+        core.setFailed("Tag name does not match regex")
+    }
+
+    // -----
+    // --------------- CHECK COMMITS
+    // ----------
+
+    // Get commits
+    let commits = []
+    if (eventName === "pull_request") {
+      // Get all commits from pull request
+      const { data } = await octokit.rest.pulls.listCommits({
+        owner: owner,
+        repo: repo,
+        pull_number: pullRequest.number
+      })
+
+      // Set commits
+      commits = data
+    } else if (eventName === "push") {
+      // Get pushed commits
+      let commitPromises = []
+
+      payload.commits.forEach(commit => {
+        commitPromises.push(octokit.rest.repos.getCommit({
+          owner: owner,
+          repo: repo,
+          ref: commit.id
+        }))
+      })
+
+      // Append commits
+      for await (const { data: commit } of commitPromises) {
+        commits.push(commit)
+      }
+    }
 
     // Check all commits
     commits.forEach(commit => {

node_modules/.package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "gitlint-action",
-  "version": "1.0.3",
+  "version": "1.1.0",
   "description": "This GitHub Action ensures that your naming conventions for commits, branches, and pull requests are being respected.",
   "main": "index.js",
   "scripts": {