Compare commits

...
4 Commits
2 changed files with 27 additions and 22 deletions
+13 -8
View File
@@ -2,6 +2,7 @@
[![GitHub Release][ico-release]][link-github-release] [![GitHub Release][ico-release]][link-github-release]
[![License][ico-license]](LICENSE) [![License][ico-license]](LICENSE)
[![Tests][ico-tests]][link-tests]
A Github Action for sending a webhook event any endpoint A Github Action for sending a webhook event any endpoint
@@ -15,7 +16,7 @@ Example:
```yml ```yml
- name: Webhook - name: Webhook
uses: joelwmale/webhook-action@master uses: joelwmale/webhook-action@v2
with: with:
url: ${{ secrets.WEBHOOK_URL }} url: ${{ secrets.WEBHOOK_URL }}
headers: '{"repository": "joelwmale/webhook-action"}' headers: '{"repository": "joelwmale/webhook-action"}'
@@ -23,19 +24,21 @@ Example:
github_event_payload: true github_event_payload: true
``` ```
It is **highly** recommended to use the action is an explicit commit SHA-1: Pin to a specific version for stability:
`uses = "joelwmale/webhook-action@{SHA-1}"` to find a commit click [here.](https://github.com/joelwmale/webhook-action/commits/master) ```yml
uses: joelwmale/webhook-action@v2.4.2
```
## Action Input ## Action Input
The action has support for the following input variables (arguments): The action has support for the following input variables (arguments):
* **`url`** (**required**): The url to send the webhook to - **`url`** (**required**): The url to send the webhook to
* **`headers`** (**optional**): Any headers you want to be sent with the webhook - **`headers`** (**optional**): Any headers you want to be sent with the webhook
* **`body`** (**optional**): The body of data send 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 - **`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. - **`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. You can find more information on how to use these input variables below.
@@ -112,4 +115,6 @@ The MIT License (MIT). Please see [License File](LICENSE) for more information.
[ico-release]: https://img.shields.io/github/tag/joelwmale/webhook-action.svg [ico-release]: https://img.shields.io/github/tag/joelwmale/webhook-action.svg
[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg [ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg
[ico-tests]: https://github.com/joelwmale/webhook-action/actions/workflows/tests.yml/badge.svg
[link-github-release]: https://github.com/joelwmale/webhook-action/releases [link-github-release]: https://github.com/joelwmale/webhook-action/releases
[link-tests]: https://github.com/joelwmale/webhook-action/actions/workflows/tests.yml
+1 -1
View File
@@ -1,6 +1,6 @@
{ {
"name": "webhook-action", "name": "webhook-action",
"version": "2.4.1", "version": "2.4.2",
"description": "Github Webhook Action", "description": "Github Webhook Action",
"main": "dist/main.js", "main": "dist/main.js",
"scripts": { "scripts": {