actions/webhook-action
1
0
Fork 0
mirror of https://github.com/joelwmale/webhook-action.git synced 2026-06-30 22:41:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

chore: bump version to 2.4.2 and update README to use semver tags

Browse Source
This commit is contained in:
Joel Male 2026-06-02 16:26:47 +10:00
parent 303dbdda5d
commit 50f3dc0b06
No known key found for this signature in database
GPG Key ID: 8C43FD2C9426C3AC
2 changed files with 24 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@ -15,7 +15,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 +23,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.
@ -47,14 +49,14 @@ You can find more information on how to use these input variables below.
The URL to send the webhook to The URL to send the webhook to
```yml ```yml
url: ${{ secrets.WEBHOOK_URL }} url: ${{ secrets.WEBHOOK_URL }}
``` ```
or or
```yml ```yml
url: https://webhook.site/8b1b1b1b-8b1b-8b1b-8b1b-8b1b1b1b1b1b url: https://webhook.site/8b1b1b1b-8b1b-8b1b-8b1b-8b1b1b1b1b1b
``` ```
#### Headers #### Headers
@ -63,8 +65,8 @@ or
Allows you to send custom headers with the request Allows you to send custom headers with the request
```yml ```yml
headers: '{"repository": "joelwmale/webhook-action"}' headers: '{"repository": "joelwmale/webhook-action"}'
``` ```
#### Body #### Body
@ -74,8 +76,8 @@ Allows you to send custom headers with the request
Allows you to send a custom JSON object to the webhook Allows you to send a custom JSON object to the webhook
```yml ```yml
body: '{"event": "deployment", "repository": "joelwmale/webhook-action"}' body: '{"event": "deployment", "repository": "joelwmale/webhook-action"}'
``` ```
#### Insecure #### Insecure
@ -85,8 +87,8 @@ Allows you to send a custom JSON object to the webhook
Allows you to send a webhook to a known self-signed or invalid SSL certificate Allows you to send a webhook to a known self-signed or invalid SSL certificate
```yml ```yml
insecure: true insecure: true
``` ```
#### Github Event Payload #### Github Event Payload
@ -98,8 +100,8 @@ 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 The payload will be sent as a JSON object under the key `githubEventPayload` on the root of the payload sent to your webhook
```yml ```yml
github_event_payload: true github_event_payload: true
``` ```
## Issues ## Issues
@ -112,4 +114,4 @@ 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
[link-github-release]: https://github.com/joelwmale/webhook-action/releases [link-github-release]: https://github.com/joelwmale/webhook-action/releases

2
package.json
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": {