Merge pull request #31 from issue-ops/ncalteen

Cleanup

.gitattributes

@@ -0,0 +1 @@
+dist/** -diff linguist-generated=true

.github/workflows/check-dist.yml

@@ -12,15 +12,14 @@ on:
     paths-ignore:
       - '**.md'
 
+permissions:
+  contents: read
+
 jobs:
   check-dist:
     name: Check dist/
     runs-on: ubuntu-latest
 
-    permissions:
-      contents: read
-      statuses: write
-
     steps:
       - name: Checkout
         id: checkout
@@ -30,7 +29,7 @@ jobs:
         id: setup-node
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version-file: .node-version
           cache: npm
 
       - name: Install Dependencies

.github/workflows/continuous-delivery.yml

@@ -7,7 +7,6 @@ on:
     branches:
       - main
 
-# This is required to be able to update tags and create releases
 permissions:
   contents: write
 
@@ -16,18 +15,17 @@ jobs:
     name: Release Version
     runs-on: ubuntu-latest
 
-    # Only run this job if the PR was merged
-    if: ${{ github.event.pull_request.merged == true }}
+    if: |
+      github.event.pull_request.merged == true &&
+      startsWith(github.head_ref, 'dependabot/') == false
 
     steps:
-      # Checkout the repository with fetch-tags set to true
       - name: Checkout
         id: checkout
         uses: actions/checkout@v4
         with:
           fetch-tags: true
 
-      # Get the version and update the tags to use in the release
       - name: Tag
         id: tag
         uses: issue-ops/semver@v0.1.0
@@ -36,8 +34,6 @@ jobs:
           workspace: ${{ github.workspace }}
           ref: main
 
-      # Use the version output from the previous step for the release
-      # Prepend a 'v' to the beginning (e.g. 'v1.2.3')
       - name: Create Release
         id: release
         uses: issue-ops/releaser@v0.1.2

.github/workflows/continuous-integration.yml

@@ -8,17 +8,16 @@ on:
     branches:
       - main
 
+permissions:
+  actions: read
+  checks: write
+  contents: read
+
 jobs:
   continuous-integration:
     name: Continuous Integration
     runs-on: ubuntu-latest
 
-    permissions:
-      actions: read
-      checks: write
-      contents: read
-      statuses: write
-
     steps:
       - name: Checkout
         id: checkout
@@ -28,7 +27,7 @@ jobs:
         id: setup-node
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version-file: .node-version
           cache: npm
 
       - name: Install Dependencies

.github/workflows/issue-created.yml

@@ -30,7 +30,7 @@ jobs:
         id: setup-node
         uses: actions/setup-node@v4
         with:
-          node-version: 20
+          node-version-file: .node-version
           cache: npm
 
       # Next, install the dependencies from `package.json`.

.github/workflows/super-linter.yml

@@ -27,9 +27,9 @@ jobs:
 
       - name: Setup Node.js
         id: setup-node
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v3
         with:
-          node-version: 20
+          node-version-file: .node-version
           cache: npm
 
       - name: Install Dependencies

.node-version

@@ -0,0 +1 @@
+20.6.0

__tests__/index.test.ts

@@ -4,12 +4,18 @@
 
 import * as main from '../src/main'
 
+let runMock: jest.SpyInstance
+
 describe('index', () => {
-  it('calls run when imported', async () => {
-    jest.spyOn(main, 'run').mockImplementation()
+  beforeEach(() => {
+    jest.clearAllMocks()
 
+    runMock = jest.spyOn(main, 'run').mockImplementation()
+  })
+
+  it('calls run when imported', async () => {
     require('../src/index')
 
-    expect(main.run).toHaveBeenCalled()
+    expect(runMock).toHaveBeenCalled()
   })
 })

__tests__/main.test.ts

@@ -30,14 +30,13 @@ jest.mock('@octokit/rest', () => ({
   Octokit: jest.fn()
 }))
 
-jest.spyOn(core, 'info').mockImplementation()
-jest.spyOn(core, 'setFailed').mockImplementation()
-jest.spyOn(core, 'setOutput').mockImplementation()
-
 describe('main', () => {
   beforeEach(() => {
     jest.clearAllMocks()
-    jest.resetAllMocks()
+
+    jest.spyOn(core, 'info').mockImplementation()
+    jest.spyOn(core, 'setFailed').mockImplementation()
+    jest.spyOn(core, 'setOutput').mockImplementation()
   })
 
   it('retrieves the inputs', async () => {

__tests__/validate.test.ts

@@ -18,14 +18,16 @@ jest.mock('@octokit/rest', () => ({
 describe('validate', () => {
   beforeEach(() => {
     jest.clearAllMocks()
-  })
 
-  it('validates each input type', async () => {
+    jest.spyOn(core, 'error').mockImplementation()
     jest.spyOn(core, 'info').mockImplementation()
     jest.spyOn(input, 'validateInput').mockImplementation()
     jest.spyOn(textarea, 'validateTextarea').mockImplementation()
     jest.spyOn(dropdown, 'validateDropdown').mockImplementation()
     jest.spyOn(checkboxes, 'validateCheckboxes').mockImplementation()
+  })
+
+  it('validates each input type', async () => {
     jest.spyOn(fs, 'existsSync').mockReturnValue(false)
 
     await validate(
@@ -67,11 +69,6 @@ describe('validate', () => {
   })
 
   it('skips custom validation if no config is present', async () => {
-    jest.spyOn(core, 'info').mockImplementation()
-    jest.spyOn(input, 'validateInput').mockImplementation()
-    jest.spyOn(textarea, 'validateTextarea').mockImplementation()
-    jest.spyOn(dropdown, 'validateDropdown').mockImplementation()
-    jest.spyOn(checkboxes, 'validateCheckboxes').mockImplementation()
     jest.spyOn(fs, 'existsSync').mockReturnValue(false)
 
     const errors: string[] = await validate(
@@ -91,12 +88,7 @@ describe('validate', () => {
   })
 
   it('passes custom validation if config is present and inputs are valid', async () => {
-    jest.spyOn(core, 'info').mockImplementation()
     jest.spyOn(core, 'getInput').mockReturnValue('1234')
-    jest.spyOn(input, 'validateInput').mockImplementation()
-    jest.spyOn(textarea, 'validateTextarea').mockImplementation()
-    jest.spyOn(dropdown, 'validateDropdown').mockImplementation()
-    jest.spyOn(checkboxes, 'validateCheckboxes').mockImplementation()
     jest.spyOn(fs, 'existsSync').mockReturnValue(true)
 
     const mocktokit = {
@@ -137,13 +129,7 @@ describe('validate', () => {
   })
 
   it('fails custom validation if config is present and inputs are invalid', async () => {
-    jest.spyOn(core, 'info').mockImplementation()
     jest.spyOn(core, 'getInput').mockReturnValue('1234')
-    jest.spyOn(core, 'error').mockImplementation()
-    jest.spyOn(input, 'validateInput').mockImplementation()
-    jest.spyOn(textarea, 'validateTextarea').mockImplementation()
-    jest.spyOn(dropdown, 'validateDropdown').mockImplementation()
-    jest.spyOn(checkboxes, 'validateCheckboxes').mockImplementation()
     jest.spyOn(fs, 'existsSync').mockReturnValue(true)
 
     const mocktokit = {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "validator",
   "description": "Validate issue form submissions",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "author": "Nick Alteen <ncalteen@github.com>",
   "homepage": "https://github.com/issue-ops/validator#readme",
   "repository": {
@@ -25,13 +25,14 @@
   "scripts": {
     "bundle": "npm run format:write && npm run package",
     "ci-test": "jest",
+    "coverage": "make-coverage-badge --output-path ./badges/coverage.svg",
     "format:write": "prettier --write '**/*.ts'",
     "format:check": "prettier --check '**/*.ts'",
     "lint": "npx eslint . -c ./.github/linters/.eslintrc.yml",
     "package": "ncc build src/index.ts -o dist --source-map --license licenses.txt",
     "package:watch": "npm run package -- --watch",
-    "test": "(jest && make-coverage-badge --output-path ./badges/coverage.svg) || make-coverage-badge --output-path ./badges/coverage.svg",
-    "all": "npm run format:write && npm run lint && npm run test && npm run package"
+    "test": "jest",
+    "all": "npm run format:write && npm run lint && npm run test && npm run coverage && npm run package"
   },
   "license": "MIT",
   "jest": {