diff --git a/README.md b/README.md index 53a86dfb..f1246ea9 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ [![GitHub Release][ico-release]][link-github-release] [![License][ico-license]](LICENSE) -A Github Action for sending data to an endpoint +A Github Action for sending a webhook event any endpoint Supports all [workflow event types](https://developer.github.com/webhooks/#events) @@ -18,40 +18,47 @@ Example: uses: joelwmale/webhook-action@master with: url: ${{ secrets.WEBHOOK_URL }} - headers: "{Content-Type: 'application/json'}" - body: "{event: 'Deployment', project: 'joelwmale/webhook-action'}" + headers: '{"repository": "joelwmale/webhook-action"}' + body: '{"event": "deployment", "repository": "joelwmale/webhook-action"}' ``` It is **highly** recommended to use the action is an explicit commit SHA-1: -`uses = "joelwmale/webhook-action@{SHA-1}"` to find a commit click here: https://github.com/joelwmale/webhook-action/commits/master +`uses = "joelwmale/webhook-action@{SHA-1}"` to find a commit click [here.](https://github.com/joelwmale/webhook-action/commits/master) -### Arguments +## Action Input -### Headers - -Allows you to send custom headers with the request - -```yml - headers: "{Repository: 'joelwmale/webhook-action'}" -``` - -### Body - -Allows you to send a json payload in a string format - -```yml - body: "{event: 'Deployment', project: 'joelwmale/webhook-action'}" -``` - -### Environment - -The action is expecpecting a few environmental variables: +The action has support for the following input variables (arguments): * **`url`** (**required**): The url to send the webhook to * **`headers`** (**optional**): Any headers you want to be sent with the webhook * **`body`** (**optional**): The body of data send with the webhook +You can find more information on how to use these input variables below. + +## Arguments + +#### Headers + +**Required:** false + +Allows you to send custom headers with the request + +```yml + headers: '{"repository": "joelwmale/webhook-action"}' +``` + +#### Body + +**Required:** false +**Must be a stringified JSON payload** + +Allows you to send a custom JSON object to the webhook + +```yml + body: '{"event": "deployment", "repository": "joelwmale/webhook-action"}' +``` + ## Issues If you find any issues or have an improvement feel free to [submit an issue](https://github.com/joelwmale/webhook-action/issues/new) diff --git a/node_modules/@vercel/ncc/dist/ncc/cli.js.cache b/node_modules/@vercel/ncc/dist/ncc/cli.js.cache index 2980b573..7ab4f61a 100644 Binary files a/node_modules/@vercel/ncc/dist/ncc/cli.js.cache and b/node_modules/@vercel/ncc/dist/ncc/cli.js.cache differ diff --git a/node_modules/@vercel/ncc/dist/ncc/index.js.cache b/node_modules/@vercel/ncc/dist/ncc/index.js.cache index 9beae519..87aec79c 100644 Binary files a/node_modules/@vercel/ncc/dist/ncc/index.js.cache and b/node_modules/@vercel/ncc/dist/ncc/index.js.cache differ diff --git a/node_modules/@vercel/ncc/dist/ncc/loaders/relocate-loader.js.cache b/node_modules/@vercel/ncc/dist/ncc/loaders/relocate-loader.js.cache index 363a4761..0d675d2b 100644 Binary files a/node_modules/@vercel/ncc/dist/ncc/loaders/relocate-loader.js.cache and b/node_modules/@vercel/ncc/dist/ncc/loaders/relocate-loader.js.cache differ diff --git a/node_modules/@vercel/ncc/dist/ncc/loaders/shebang-loader.js.cache b/node_modules/@vercel/ncc/dist/ncc/loaders/shebang-loader.js.cache index 57807455..d7d98c3b 100644 Binary files a/node_modules/@vercel/ncc/dist/ncc/loaders/shebang-loader.js.cache and b/node_modules/@vercel/ncc/dist/ncc/loaders/shebang-loader.js.cache differ diff --git a/package.json b/package.json index 55588ce7..3772102f 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,6 @@ { "name": "webhook-action", - "version": "1.0.1", - "private": true, + "version": "2.0.2", "description": "Github Webhook Action", "main": "dist/main.js", "scripts": { @@ -15,6 +14,7 @@ "url": "git+https://github.com/joelwmale/webhook-action.git" }, "keywords": [ + "github", "actions", "node", "webhook",