@zentered/issue-forms-body-parser 2.0.0 → 2.1.1

package/.github/workflows/codeql-analysis.yml

@@ -1,11 +1,11 @@
-name: "CodeQL"
+name: 'CodeQL'
 
 on:
   push:
-    branches: [ main ]
+    branches: [main]
   pull_request:
     # The branches below must be a subset of the branches above
-    branches: [ main ]
+    branches: [main]
   schedule:
     - cron: '29 21 * * 5'
 
@@ -21,39 +21,39 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        language: [ 'javascript' ]
+        language: ['javascript']
         # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ]
         # Learn more about CodeQL language support at https://git.io/codeql-language-support
 
     steps:
-    - name: Checkout repository
-      uses: actions/checkout@v3
-
-    # Initializes the CodeQL tools for scanning.
-    - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
-      with:
-        languages: ${{ matrix.language }}
-        # If you wish to specify custom queries, you can do so here or in a config file.
-        # By default, queries listed here will override any specified in a config file.
-        # Prefix the list here with "+" to use these queries and those in the config file.
-        # queries: ./path/to/local/query, your-org/your-repo/queries@main
-
-    # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
-    # If this step fails, then you should remove it and run the build manually (see below)
-    - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
-
-    # ℹ️ Command-line programs to run using the OS shell.
-    # 📚 https://git.io/JvXDl
-
-    # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
-    #    and modify them (or add more) to build your code if your project
-    #    uses a compiled language
-
-    #- run: |
-    #   make bootstrap
-    #   make release
-
-    - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      # Initializes the CodeQL tools for scanning.
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v2
+        with:
+          languages: ${{ matrix.language }}
+          # If you wish to specify custom queries, you can do so here or in a config file.
+          # By default, queries listed here will override any specified in a config file.
+          # Prefix the list here with "+" to use these queries and those in the config file.
+          # queries: ./path/to/local/query, your-org/your-repo/queries@main
+
+      # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v2
+
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+
+      # ✏️ If the Autobuild fails above, remove it and uncomment the following three lines
+      #    and modify them (or add more) to build your code if your project
+      #    uses a compiled language
+
+      #- run: |
+      #   make bootstrap
+      #   make release
+
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v2

package/.github/workflows/end-to-end-test.yml

@@ -10,4 +10,17 @@ jobs:
       - name: Issue Forms Body Parser
         id: parse
         uses: ./
-      - run: echo "${{ toJSON(steps.parse.outputs.data) }}"
+      - run: echo ${{ toJSON(steps.parse.outputs.data) }}
+
+      - name: Read an issue content
+        id: read_issue
+        run: |
+          echo "body<<EOF" >> $GITHUB_OUTPUT
+          cat ./test/test-issue-3.md >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+      - name: Issue Forms Body Parser With Provided Body
+        id: parse_with_body
+        uses: ./
+        with:
+          body: ${{ steps.read_issue.outputs.body }}
+      - run: echo ${{ toJSON(steps.parse_with_body.outputs.data) }}

package/.github/workflows/publish.yml

@@ -19,6 +19,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 18
+          cache: 'npm'
       - run: npm ci
       - run: npm test
       - run: npm run release

package/.github/workflows/test.yml

@@ -17,8 +17,33 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
+      - uses: actions/setup-node@v3
         with:
-          fetch-depth: 0
+          node-version: 18
+          cache: 'npm'
       - run: npm ci
       - run: npm run lint
       - run: npm test
+
+      - run: npm run build
+
+      - name: Read an issue content
+        id: read_issue
+        run: |
+          echo "body<<EOF" >> $GITHUB_OUTPUT
+          cat ./test/test-issue-3.md >> $GITHUB_OUTPUT
+          echo "EOF" >> $GITHUB_OUTPUT
+      - name: Issue Forms Body Parser With Provided Body
+        id: parse_with_body
+        uses: ./
+        with:
+          body: ${{ steps.read_issue.outputs.body }}
+
+      - name: Test input body parsed
+        run: |
+          expected="Event Description"
+          title=$(echo ${{ toJSON(steps.parse_with_body.outputs.data) }} | jq -r '.["event-description"].title')
+          if [[ $title != $expected ]]; then
+            echo "Title \"${title}\" does not match \"${expected}\""
+            exit 1
+          fi

package/.nyc_output/processinfo/182604fc-3245-46df-92b3-32625abb4267.json

@@ -0,0 +1 @@
+{"parent":null,"pid":1823,"argv":["/opt/hostedtoolcache/node/18.13.0/x64/bin/node","/home/runner/work/issue-forms-body-parser/issue-forms-body-parser/node_modules/.bin/tap","--node-arg=--experimental-json-modules","--test-env=GITHUB_REPOSITORY=zentered/issue-forms-body-parser-test","-J","test/parse-issue.test.js"],"execArgv":[],"cwd":"/home/runner/work/issue-forms-body-parser/issue-forms-body-parser","time":1673864641514,"ppid":1812,"coverageFilename":"/home/runner/work/issue-forms-body-parser/issue-forms-body-parser/.nyc_output/182604fc-3245-46df-92b3-32625abb4267.json","externalId":"","uuid":"182604fc-3245-46df-92b3-32625abb4267","files":[]}

package/.nyc_output/processinfo/da1c3cfe-7c8a-4d2a-9350-accc36357a09.json

@@ -0,0 +1 @@
+{"parent":"182604fc-3245-46df-92b3-32625abb4267","pid":1835,"argv":["/opt/hostedtoolcache/node/18.13.0/x64/bin/node","/home/runner/work/issue-forms-body-parser/issue-forms-body-parser/test/parse-issue.test.js"],"execArgv":["--experimental-json-modules"],"cwd":"/home/runner/work/issue-forms-body-parser/issue-forms-body-parser","time":1673864641856,"ppid":1823,"coverageFilename":"/home/runner/work/issue-forms-body-parser/issue-forms-body-parser/.nyc_output/da1c3cfe-7c8a-4d2a-9350-accc36357a09.json","externalId":"test/parse-issue.test.js","uuid":"da1c3cfe-7c8a-4d2a-9350-accc36357a09","files":[]}

package/.nyc_output/processinfo/index.json

@@ -1 +1 @@
-{"processes":{"78e2aab5-e45b-4d92-a67a-363ff5cbfcf8":{"parent":"97cfe5ec-7f32-43f6-a236-732be371a17f","externalId":"test/parse-issue.test.js","children":[]},"97cfe5ec-7f32-43f6-a236-732be371a17f":{"parent":null,"children":["78e2aab5-e45b-4d92-a67a-363ff5cbfcf8"]}},"files":{},"externalIds":{"test/parse-issue.test.js":{"root":"78e2aab5-e45b-4d92-a67a-363ff5cbfcf8","children":[]}}}
+{"processes":{"182604fc-3245-46df-92b3-32625abb4267":{"parent":null,"children":["da1c3cfe-7c8a-4d2a-9350-accc36357a09"]},"da1c3cfe-7c8a-4d2a-9350-accc36357a09":{"parent":"182604fc-3245-46df-92b3-32625abb4267","externalId":"test/parse-issue.test.js","children":[]}},"files":{},"externalIds":{"test/parse-issue.test.js":{"root":"da1c3cfe-7c8a-4d2a-9350-accc36357a09","children":[]}}}

package/CODE_OF_CONDUCT.md

@@ -6,8 +6,8 @@ We as members, contributors, and leaders pledge to make participation in our
 community a harassment-free experience for everyone, regardless of age, body
 size, visible or invisible disability, ethnicity, sex characteristics, gender
 identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, religion, or sexual identity
-and orientation.
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
 
 We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
@@ -17,23 +17,23 @@ diverse, inclusive, and healthy community.
 Examples of behavior that contributes to a positive environment for our
 community include:
 
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
   and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the
-  overall community
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
 
 Examples of unacceptable behavior include:
 
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
   professional setting
 
 ## Enforcement Responsibilities
@@ -60,8 +60,8 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-contact@zentered.co.
-All complaints will be reviewed and investigated promptly and fairly.
+contact@zentered.co. All complaints will be reviewed and investigated promptly
+and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
 reporter of any incident.
@@ -82,15 +82,15 @@ behavior was inappropriate. A public apology may be requested.
 
 ### 2. Warning
 
-**Community Impact**: A violation through a single incident or series
-of actions.
+**Community Impact**: A violation through a single incident or series of
+actions.
 
 **Consequence**: A warning with consequences for continued behavior. No
 interaction with the people involved, including unsolicited interaction with
 those enforcing the Code of Conduct, for a specified period of time. This
 includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or
-permanent ban.
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
 
 ### 3. Temporary Ban
 
@@ -106,11 +106,11 @@ Violating these terms may lead to a permanent ban.
 ### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior,  harassment of an
+standards, including sustained inappropriate behavior, harassment of an
 individual, or aggression toward or disparagement of classes of individuals.
 
-**Consequence**: A permanent ban from any sort of public interaction within
-the community.
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
 
 ## Attribution
 
@@ -118,8 +118,8 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
 version 2.0, available at
 https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
 
-Community Impact Guidelines were inspired by [Mozilla's code of conduct
-enforcement ladder](https://github.com/mozilla/diversity).
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
 
 [homepage]: https://www.contributor-covenant.org
 

package/CONTRIBUTING.md

@@ -1,11 +1,15 @@
 # How to contribute
 
-We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.
+We'd love to accept your patches and contributions to this project. There are
+just a few small guidelines you need to follow.
 
 ## Code reviews
 
-All submissions require review. We use GitHub pull requests for this purpose. Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for more information on using pull requests.
+All submissions require review. We use GitHub pull requests for this purpose.
+Consult [GitHub Help](https://help.github.com/articles/about-pull-requests/) for
+more information on using pull requests.
 
 ## Style Guide
 
-This project provides a prettier configuration. All submitted PRs will be required to conform to this style guide before being merged.
+This project provides a prettier configuration. All submitted PRs will be
+required to conform to this style guide before being merged.

package/README.md

@@ -117,7 +117,40 @@ jobs:
     steps:
       - name: Issue Forms Body Parser
         id: parse
-        uses: zentered/issue-forms-body-parser@v1.4.3
+        uses: zentered/issue-forms-body-parser@v2.0.0
+      - run: echo "${{ JSON.stringify(steps.parse.outputs.data) }}"
+```
+
+You can also provide a custom `body` input:
+
+```yml
+name: Issue Forms Body Parser
+
+on:
+  workflow_dispatch:
+    inputs:
+      issue_number:
+        type: string
+        required: true
+env:
+  GH_TOKEN: ${{ github.token }}
+
+jobs:
+  process:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Fetch the issue
+        id: read_issue_body
+        run:
+          echo "body=$(gh issue view ${{ inputs.issue_number }} --repo ${{
+          github.repo }} --json body --jq '.body')" >> $GITHUB_OUTPUT
+
+      - name: Issue Forms Body Parser
+        id: parse
+        uses: zentered/issue-forms-body-parser@v2.0.0
+        with:
+          body: ${{ steps.read_issue_body.output.body }}
+
       - run: echo "${{ JSON.stringify(steps.parse.outputs.data) }}"
 ```
 
@@ -141,7 +174,7 @@ const issueData = await bodyParser(issue.body)
 
 You can use [act](https://github.com/nektos/act) to test this Action locally.
 
-`npm run build && act issue -e test/issue.json`
+`npm run build && act issues -e test/issue.json`
 
 or run:
 

package/action.yml

@@ -6,6 +6,9 @@ description:
 branding:
   color: blue
   icon: chevron-right
+inputs:
+  body:
+    description: 'The body to parse.'
 outputs:
   data:
     description:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zentered/issue-forms-body-parser",
-  "version": "2.0.0",
+  "version": "2.1.1",
   "private": false,
   "description": "Parser for GitHub Issue Form body, also available as GitHub Action",
   "keywords": [
@@ -25,6 +25,10 @@
       "name": "Patrick Heneise",
       "url": "https://zentered.co",
       "author": true
+    },
+    {
+      "name": "Benjamin Grandfond",
+      "url": "https://github.com/benja-M-1"
     }
   ],
   "type": "module",
@@ -39,9 +43,7 @@
     "license-checker": "license-checker --production --onlyAllow=\"MIT;ISC;BSD-3-Clause;BSD-2-Clause;Apache-2.0\"",
     "test": "tap --node-arg=--experimental-json-modules --test-env=GITHUB_REPOSITORY=zentered/issue-forms-body-parser-test -J test/*.test.js",
     "test:report": "tap --test-env=GITHUB_REPOSITORY=zentered/issue-forms-body-parser-test -J test/*.test.js --cov",
-    "_postinstall": "husky install",
-    "prepublishOnly": "pinst --disable",
-    "postpublish": "pinst --enable"
+    "prepare": "is-ci || husky install"
   },
   "commitlint": {
     "extends": [
@@ -67,6 +69,7 @@
     "@sindresorhus/slugify": "^2.1.1",
     "date-fns": "^2.29.3",
     "date-fns-tz": "^1.3.7",
+    "is-ci": "^3.0.1",
     "remark-gfm": "^3.0.1",
     "remark-parse": "^10.0.1",
     "remark-stringify": "^10.0.2",
@@ -74,19 +77,19 @@
     "unified": "^10.1.2"
   },
   "devDependencies": {
-    "@commitlint/config-conventional": "^17.3.0",
+    "@commitlint/config-conventional": "^17.4.2",
     "@vercel/ncc": "^0.36.0",
-    "commitlint": "^17.3.0",
-    "eslint": "^8.31.0",
+    "commitlint": "^17.4.2",
+    "eslint": "^8.32.0",
     "eslint-plugin-json": "^3.1.0",
     "eslint-plugin-node": "^11.1.0",
-    "husky": "^8.0.2",
+    "husky": "^8.0.3",
     "license-checker": "^25.0.1",
     "microbundle": "^0.15.1",
     "npm-run-all": "^4.1.5",
     "pinst": "^3.0.0",
-    "prettier": "^2.8.1",
-    "tap": "^16.3.2"
+    "prettier": "^2.8.3",
+    "tap": "^16.3.4"
   },
   "src": "src/parse.js"
 }

package/src/index.js

@@ -7,8 +7,14 @@ import parse from './parse.js'
 async function run() {
   core.info('Parsing issue body ...')
 
+  let content = core.getInput('body')
+
+  if (content === '' && Object.hasOwn(github.context.payload, 'issue')) {
+    content = github.context.payload.issue.body
+  }
+
   try {
-    const parsedContent = await parse(github.context.payload.issue.body)
+    const parsedContent = await parse(content)
 
     if (parsedContent !== undefined) {
       core.setOutput('data', parsedContent)

package/.nyc_output/processinfo/78e2aab5-e45b-4d92-a67a-363ff5cbfcf8.json

@@ -1 +0,0 @@
-{"parent":"97cfe5ec-7f32-43f6-a236-732be371a17f","pid":2031,"argv":["/usr/local/bin/node","/home/runner/work/issue-forms-body-parser/issue-forms-body-parser/test/parse-issue.test.js"],"execArgv":["--experimental-json-modules"],"cwd":"/home/runner/work/issue-forms-body-parser/issue-forms-body-parser","time":1672678697041,"ppid":2020,"coverageFilename":"/home/runner/work/issue-forms-body-parser/issue-forms-body-parser/.nyc_output/78e2aab5-e45b-4d92-a67a-363ff5cbfcf8.json","externalId":"test/parse-issue.test.js","uuid":"78e2aab5-e45b-4d92-a67a-363ff5cbfcf8","files":[]}

package/.nyc_output/processinfo/97cfe5ec-7f32-43f6-a236-732be371a17f.json

@@ -1 +0,0 @@
-{"parent":null,"pid":2020,"argv":["/usr/local/bin/node","/home/runner/work/issue-forms-body-parser/issue-forms-body-parser/node_modules/.bin/tap","--node-arg=--experimental-json-modules","--test-env=GITHUB_REPOSITORY=zentered/issue-forms-body-parser-test","-J","test/parse-issue.test.js"],"execArgv":[],"cwd":"/home/runner/work/issue-forms-body-parser/issue-forms-body-parser","time":1672678696683,"ppid":2009,"coverageFilename":"/home/runner/work/issue-forms-body-parser/issue-forms-body-parser/.nyc_output/97cfe5ec-7f32-43f6-a236-732be371a17f.json","externalId":"","uuid":"97cfe5ec-7f32-43f6-a236-732be371a17f","files":[]}