Merge pull request #5 from tim-actions/feature-filter-out

Add feature "filter out by pattern"

Author: Tim-Zhang

action.yml

@@ -4,6 +4,14 @@ inputs:
   token:
     description: 'A token with access to your repository scoped in as a secret'
     required: true
+  filter_out_pattern:
+    description: 'A regex pattern to check if a commit should be filtered out, empty for disable'
+    required: false
+    default: ""
+  filter_out_flags:
+    description: 'Regex flags of input filter_out_pattern'
+    required: false
+    default: ''
 outputs:
   commits:
     description: 'commits in pr'

index.js

@@ -13,15 +13,26 @@ async function main() {
     }
 
     const token = core.getInput('token')
+    const filterOutPattern = core.getInput('filter_out_pattern')
+    const filterOutFlags = core.getInput('filter_out_flags')
     const octokit = new github.GitHub(token)
 
-    const commits = await octokit.pulls.listCommits({
+    const commitsListed = await octokit.pulls.listCommits({
       owner: repo.owner.login,
       repo: repo.name,
       pull_number: pr.number,
     })
 
-    core.setOutput('commits', JSON.stringify(commits.data))
+    let commits = commitsListed.data
+
+    if (filterOutPattern) {
+      const regex = new RegExp(filterOutPattern, filterOutFlags)
+      commits = commits.filter(({commit}) => {
+        return !regex.test(commit.message)
+      })
+    }
+
+    core.setOutput('commits', JSON.stringify(commits))
   } catch (error) {
     core.setFailed(error.message)
   }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "get-pr-commits",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "",
   "main": "index.js",
   "scripts": {