Merge pull request #12 from marocchino/detect

✨ Add detect action

.github/workflows/detect.yml

@@ -0,0 +1,22 @@
+name: 'detect-test'
+on:
+  pull_request:
+    types:
+      - edited
+jobs:
+  detect:
+    runs-on: ubuntu-latest
+    outputs:
+      checked: ${{ steps.detect.outputs.checked }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./
+        id: detect
+        with:
+          action: 'detect'
+  test:
+    needs: detect
+    if: ${{ contains(fromJSON(needs.detect.outputs.checked), 'trigger test') }}
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo TEST TRIGGERED

CODEOWNERS

@@ -1 +1 @@
-* @actions/actions-runtime
+* @marocchino

LICENSE

@@ -1,7 +1,7 @@
 
 The MIT License (MIT)
 
-Copyright (c) 2018 GitHub, Inc. and contributors
+Copyright marocchino and contributors
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -19,4 +19,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.
+THE SOFTWARE.

README.md

@@ -34,6 +34,34 @@ I think the most common use is to visualize the results of CI execution, and her
           error: 'warn'
 ```
 
+Here's an example of checking to see if a particular checkbox has been checked recently.
+Unchecking works the same way.
+> NOTE: I don't think detect will work again on events other than edit.
+
+```yaml
+on:
+  pull_request:
+    types:
+      - edited
+jobs:
+  detect:
+    runs-on: ubuntu-latest
+    outputs:
+      checked: ${{ steps.detect.outputs.checked }}
+    steps:
+      - uses: actions/checkout@v3
+      - uses: marocchino/checkbox-action@v1
+        id: detect
+        with:
+          action: 'detect'
+  test:
+    needs: detect
+    if: ${{ contains(fromJSON(needs.detect.outputs.checked), 'trigger test') }}
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo Add your CI here
+```
+
 ## Inputs
 
 ### `list`
@@ -48,7 +76,7 @@ Regular expression for the checkbox to modify.
 
 ### `action`
 
-**Optional** check, uncheck. This default to `'check'`
+**Optional** check, uncheck or detect. This default to `'check'`
 
 ### `error`
 
@@ -60,4 +88,12 @@ Regular expression for the checkbox to modify.
 
 ## Outputs
 
-No output
+Only available on `detect` action.
+
+### `checked`
+
+Returns a list of checked items from the previous modification as json in []string.
+
+### `unchecked`
+
+Returns a list of checked items from the previous modification as json in []string.

__tests__/detect.test.ts

@@ -0,0 +1,42 @@
+import {expect, describe, test} from '@jest/globals'
+import {getDiff} from '../src/detect'
+
+describe('getDiff', () => {
+  test('should return checked and unchecked items', () => {
+    const previousBody = `
+# Title line
+normal line
+abnormal line - [ ] item 3
+abnormal line - [x] item 4
+
+- [x] item 0 unchanged
+- [x] item 1 unchecked
+- [ ] item 2 unchanged
+  - [ ] item 2-1 checked
+  - [ ] item 2-2 unchanged
+  - [ ] item 2-3 checked
+  - [x] item 2-4 unchecked
+
+removed line
+`
+    const currentBody = `
+# Title line
+normal line
+abnormal line - [ ] item 3
+abnormal line - [x] item 4
+added line
+
+- [x] item 0 unchanged
+- [ ] item 1 unchecked
+- [ ] item 2 unchanged
+  - [x] item 2-1 checked
+  - [ ] item 2-2 unchanged
+  - [x] item 2-3 checked
+  - [ ] item 2-4 unchecked
+`
+
+    const {checked, unchecked} = getDiff(previousBody, currentBody)
+    expect(checked).toEqual(['item 2-1 checked', 'item 2-3 checked'])
+    expect(unchecked).toEqual(['item 1 unchecked', 'item 2-4 unchecked'])
+  })
+})

action.yml

@@ -21,7 +21,7 @@ inputs:
     default: ''
   action:
     required: false
-    description: 'check, uncheck. This default to check'
+    description: 'check, uncheck or detect. This default to check'
     default: 'check'
   error:
     required: false
@@ -31,6 +31,11 @@ inputs:
     description: "The GitHub access token (e.g. secrets.GITHUB_TOKEN) used to update the body. This defaults to {{ github.token }}."
     default: "${{ github.token }}"
     required: false
+outputs:
+  checked:
+    description: 'Returns a list of checked items from the previous modification as json in []string.'
+  unchecked:
+    description: 'Returns a list of unchecked items from the previous modification as json in []string.'
 runs:
   using: 'node16'
   main: 'dist/index.js'

src/config.ts

@@ -1,6 +1,6 @@
 import * as core from '@actions/core'
 
-export type Action = 'check' | 'uncheck'
+export type Action = 'check' | 'uncheck' | 'detect'
 export type ErrorLevel = 'error' | 'warn' | 'ignore'
 
 export const list = core.getMultilineInput('list', {required: false})

src/detect.ts

@@ -0,0 +1,43 @@
+import * as github from '@actions/github'
+
+export function getPreviousBody(): string {
+  if (!github.context.payload.pull_request) {
+    throw new Error('This action only supports pull_request events')
+  }
+  return github.context.payload.changes.body.from
+}
+
+export function getCurrentBody(): string {
+  if (!github.context.payload.pull_request) {
+    throw new Error('This action only supports pull_request events')
+  }
+
+  return github.context.payload.pull_request.body || ''
+}
+
+export function getDiff(
+  previousBody: string,
+  currentBody: string
+): {checked: string[]; unchecked: string[]} {
+  const previousLines = previousBody.split('\n')
+  const currentLines = currentBody.split('\n')
+
+  const checkRegexp = /^\s*- \[x\] /
+  const uncheckRegexp = /^\s*- \[ \] /
+  const prevChecked: string[] = previousLines
+    .filter(line => checkRegexp.test(line))
+    .map(line => line.replace(checkRegexp, ''))
+  const prevUnchecked: string[] = previousLines
+    .filter(line => uncheckRegexp.test(line))
+    .map(line => line.replace(uncheckRegexp, ''))
+  const currChecked: string[] = currentLines
+    .filter(line => checkRegexp.test(line))
+    .map(line => line.replace(checkRegexp, ''))
+  const currUnchecked: string[] = currentLines
+    .filter(line => uncheckRegexp.test(line))
+    .map(line => line.replace(uncheckRegexp, ''))
+  const checked = currChecked.filter(line => prevUnchecked.includes(line))
+  const unchecked = currUnchecked.filter(line => prevChecked.includes(line))
+
+  return {checked, unchecked}
+}

src/main.ts

@@ -1,9 +1,18 @@
 import * as core from '@actions/core'
-import {error} from './config'
+import {action, error} from './config'
 import {getBody, contains, update, mutate} from './check'
+import {getPreviousBody, getCurrentBody, getDiff} from './detect'
 
 async function run(): Promise<void> {
   try {
+    if (action === 'detect') {
+      const previousBody = getPreviousBody()
+      const currentBody = getCurrentBody()
+      const {checked, unchecked} = getDiff(previousBody, currentBody)
+      core.setOutput('checked', JSON.stringify(checked))
+      core.setOutput('unchecked', JSON.stringify(unchecked))
+      return
+    }
     let body = await getBody()
     if (!contains(body)) {
       switch (error) {