Compare commits

..

4 Commits
develop ... v2

Author SHA1 Message Date
Joel Male
e90574c974 docs: add CI tests badge to README 2026-06-02 16:28:24 +10:00
Joel Male
50f3dc0b06 chore: bump version to 2.4.2 and update README to use semver tags 2026-06-02 16:26:47 +10:00
Joel Male
303dbdda5d Merge branch 'develop' 2026-06-02 16:21:32 +10:00
Joel Male
cc1a66f987 Merge pull request #677 from joelwmale/develop
v2.4.1
2024-03-31 22:31:56 +10:00
2 changed files with 27 additions and 22 deletions

View File

@@ -2,6 +2,7 @@
[![GitHub Release][ico-release]][link-github-release]
[![License][ico-license]](LICENSE)
[![Tests][ico-tests]][link-tests]
A Github Action for sending a webhook event any endpoint
@@ -15,7 +16,7 @@ Example:
```yml
- name: Webhook
uses: joelwmale/webhook-action@master
uses: joelwmale/webhook-action@v2
with:
url: ${{ secrets.WEBHOOK_URL }}
headers: '{"repository": "joelwmale/webhook-action"}'
@@ -23,19 +24,21 @@ Example:
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
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
* **`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.
- **`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
- **`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.
@@ -47,14 +50,14 @@ You can find more information on how to use these input variables below.
The URL to send the webhook to
```yml
url: ${{ secrets.WEBHOOK_URL }}
```yml
url: ${{ secrets.WEBHOOK_URL }}
```
or
```yml
url: https://webhook.site/8b1b1b1b-8b1b-8b1b-8b1b-8b1b1b1b1b1b
```yml
url: https://webhook.site/8b1b1b1b-8b1b-8b1b-8b1b-8b1b1b1b1b1b
```
#### Headers
@@ -63,8 +66,8 @@ or
Allows you to send custom headers with the request
```yml
headers: '{"repository": "joelwmale/webhook-action"}'
```yml
headers: '{"repository": "joelwmale/webhook-action"}'
```
#### Body
@@ -74,8 +77,8 @@ Allows you to send custom headers with the request
Allows you to send a custom JSON object to the webhook
```yml
body: '{"event": "deployment", "repository": "joelwmale/webhook-action"}'
```yml
body: '{"event": "deployment", "repository": "joelwmale/webhook-action"}'
```
#### Insecure
@@ -85,8 +88,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
```yml
insecure: true
```yml
insecure: true
```
#### Github Event Payload
@@ -98,8 +101,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
```yml
github_event_payload: true
```yml
github_event_payload: true
```
## Issues
@@ -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-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg
[link-github-release]: https://github.com/joelwmale/webhook-action/releases
[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-tests]: https://github.com/joelwmale/webhook-action/actions/workflows/tests.yml

View File

@@ -1,6 +1,6 @@
{
"name": "webhook-action",
"version": "2.4.1",
"version": "2.4.2",
"description": "Github Webhook Action",
"main": "dist/main.js",
"scripts": {