Merge pull request #674 from joelwmale/develop

v2.3.0

.eslintignore

@@ -1 +1,2 @@
-dist/
+dist
+node_nodules

.eslintrc.json

@@ -1,18 +1,33 @@
 {
     "env": {
-        "commonjs": true,
+        "node": true,
         "es6": true,
-        "jest": true,
-        "node": true
+        "jest": true
     },
-    "extends": "eslint:recommended",
     "globals": {
         "Atomics": "readonly",
         "SharedArrayBuffer": "readonly"
     },
+    "parser": "@typescript-eslint/parser",
     "parserOptions": {
-        "ecmaVersion": 2018
+        "ecmaVersion": 9,
+        "sourceType": "module",
+        "project": "./tsconfig.json"
     },
+    "plugins": [
+        "jest",
+        "@typescript-eslint"
+    ],
+    "extends": [
+        "plugin:github/recommended",
+        "eslint:recommended",
+        "plugin:@typescript-eslint/eslint-recommended",
+        "plugin:@typescript-eslint/recommended"
+    ],
     "rules": {
+        "@typescript-eslint/no-explicit-any": "off",
+        "github/no-then": "off",
+        "import/no-namespace": "off",
+        "i18n-text/no-en": "off"
     }
 }

.github/dependabot.yml

@@ -6,4 +6,4 @@ updates:
     directory: "/"
     # Check the npm registry for updates every day (weekdays)
     schedule:
-      interval: "daily"
+      interval: "weekly"

.github/workflows/tests.yml

@@ -0,0 +1,40 @@
+name: Tests
+
+on:
+  push:
+    branches:
+      - master
+      - develop
+  pull_request:
+    branches:
+      - master
+  release:
+    types:
+      - created
+
+jobs:
+  tests:
+    name: Tests
+    runs-on: ubuntu-20.04
+
+    strategy:
+      fail-fast: true
+      matrix:
+        node-version: [20.x]
+        stability: [prefer-stable]
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile --${{ matrix.stability }}
+
+      - name: Execute tests
+        run: yarn test

.gitignore

@@ -1,53 +1 @@
-# Rest pulled from https://github.com/github/gitignore/blob/master/Node.gitignore
-# Logs
-logs
-*.log
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-lerna-debug.log*
-
-# Diagnostic reports (https://nodejs.org/api/report.html)
-report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# TypeScript v1 declaration files
-typings/
-
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-# Optional REPL history
-.node_repl_history
-
-# Output of 'npm pack'
-*.tgz
-
-# Yarn Integrity file
-.yarn-integrity
-
-# dotenv environment variables file
-.env
-.env.test
-
-# DynamoDB Local files
-.dynamodb/
-
-# OS metadata
-.DS_Store
-Thumbs.db
-
-# Ignore built ts files
-__tests__/runner/*
-lib/**/*
+node_modules/*

README.md

@@ -20,6 +20,7 @@ Example:
     url: ${{ secrets.WEBHOOK_URL }}
     headers: '{"repository": "joelwmale/webhook-action"}'
     body: '{"event": "deployment", "repository": "joelwmale/webhook-action"}'
+    github_event_payload: true
 ```
 
 It is **highly** recommended to use the action is an explicit commit SHA-1:
@@ -34,11 +35,28 @@ The action has support for the following input variables (arguments):
 * **`headers`** (**optional**): Any headers you want to be sent with the webhook
 * **`body`** (**optional**): The body of data send with the webhook
 * **`insecure`** (**optional**): Enables calling to known self-signed or invalid SSL certificates
+* **`github_event_payload`** (**optional**): Enables forwarding the Github event payload to your webhook.
 
 You can find more information on how to use these input variables below.
 
 ## Arguments
 
+#### URL
+
+**Required:** true
+
+The URL to send the webhook to
+
+```yml 
+  url: ${{ secrets.WEBHOOK_URL }}
+```
+
+or
+
+```yml 
+  url: https://webhook.site/8b1b1b1b-8b1b-8b1b-8b1b-8b1b1b1b1b1b
+```
+
 #### Headers
 
 **Required:** false
@@ -60,6 +78,30 @@ Allows you to send a custom JSON object to the webhook
   body: '{"event": "deployment", "repository": "joelwmale/webhook-action"}'
 ```
 
+#### Insecure
+
+**Required:** false
+**Default:** false
+
+Allows you to send a webhook to a known self-signed or invalid SSL certificate
+
+```yml 
+  insecure: true
+```
+
+#### Github Event Payload
+
+**Required:** false
+**Default:** false
+
+Allows you to send the Github event payload to your webhook
+
+The payload will be sent as a JSON object under the key `githubEventPayload` on the root of the payload sent to your webhook
+
+```yml 
+  github_event_payload: true
+```
+
 ## Issues
 
 If you find any issues or have an improvement feel free to [submit an issue](https://github.com/joelwmale/webhook-action/issues/new)

__tests__/main.test.ts

@@ -0,0 +1,31 @@
+import {http} from '../src/http'
+import {expect, test} from '@jest/globals'
+
+test('it makes a post request', async () => {
+  const url = 'https://httpbin.org/post'
+  const body = '{"hello": "world"}'
+  const res = await http.make(url, body)
+  expect(res.status).toBe(200)
+})
+
+test('it makes a post request with insecure', async () => {
+  const url = 'https://httpbin.org/post'
+  const body = '{"hello": "world"}'
+  const insecure = true
+  const res = await http.make(url, body, null, insecure)
+  expect(res.status).toBe(200)
+})
+
+test('it makes a post request with headers', async () => {
+  const url = 'https://httpbin.org/post'
+  const body = '{"hello": "world"}'
+  const headers = '{"Content-Type": "application/json"}'
+  const res = await http.make(url, body, headers)
+  expect(res.status).toBe(200)
+})
+
+test('it doesnt require a body', async () => {
+  const url = 'https://httpbin.org/post'
+  const res = await http.make(url, null)
+  expect(res.status).toBe(200)
+})

action.yml

@@ -17,9 +17,13 @@ inputs:
   insecure:
     description: 'Enables calling to known self-signed or invalid SSL certificates'
     required: false
+  github_event_payload:
+    description: 'Include the github event payload that triggered the action in the payload'
+    required: false
 outputs:
   status: 
     description: 'The status of the webhook event'
 runs:
-  using: 'node16'
+  using: 'node20'
   main: 'dist/index.js'
+  post: 'dist/index.js'

babel.config.js

@@ -0,0 +1 @@
+module.exports = {presets: ['@babel/preset-env']}