Compare commits

...
Author SHA1 Message Date
dependabot[bot]andGitHub 222555711e build(deps-dev): bump js-yaml from 4.2.0 to 4.3.0
Bumps [js-yaml](https://github.com/nodeca/js-yaml) from 4.2.0 to 4.3.0.
- [Changelog](https://github.com/nodeca/js-yaml/blob/master/CHANGELOG.md)
- [Commits](https://github.com/nodeca/js-yaml/compare/4.2.0...4.3.0)

---
updated-dependencies:
- dependency-name: js-yaml
  dependency-version: 4.3.0
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
2026-07-28 01:04:46 +00:00
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 MaleandGitHub cc1a66f987 Merge pull request #677 from joelwmale/develop
v2.4.1
2024-03-31 22:31:56 +10:00
4 changed files with 39 additions and 33 deletions
+26 -21
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
+7 -6
View File
@@ -1,12 +1,12 @@
{
"name": "webhook-action",
"version": "2.4.1",
"version": "2.4.2",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "webhook-action",
"version": "2.4.1",
"version": "2.4.2",
"license": "MIT",
"dependencies": {
"@actions/core": "^2.0.3",
@@ -26,7 +26,7 @@
"eslint-plugin-jest": "^27.9.0",
"https": "^1.0.0",
"jest": "^29.7.0",
"js-yaml": "^4.1.0",
"js-yaml": "^4.3.0",
"prettier": "3.2.5",
"semver": "^7.6.0",
"ts-jest": "^29.0.3",
@@ -8069,9 +8069,9 @@
"dev": true
},
"node_modules/js-yaml": {
"version": "4.2.0",
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.2.0.tgz",
"integrity": "sha512-ePWsvanv0DWuDRsW8dnt+R4jQ31SCRCQ7hhNcPXZPsoBZiemuZNYGf7adZdqX2D86j6rvKp3RpCxVTSb8WQlOw==",
"version": "4.3.0",
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.3.0.tgz",
"integrity": "sha512-1td788aAnnZ5qs7V2QIRl1owjtYpbKt749Y3xauqQgwIIGF/xXWz1wMTEBx5O3LK3lXLVuqXPdPxj2BoFHaW9Q==",
"dev": true,
"funding": [
{
@@ -8083,6 +8083,7 @@
"url": "https://github.com/sponsors/nodeca"
}
],
"license": "MIT",
"dependencies": {
"argparse": "^2.0.1"
},
+2 -2
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": {
@@ -42,7 +42,7 @@
"eslint-plugin-jest": "^27.9.0",
"https": "^1.0.0",
"jest": "^29.7.0",
"js-yaml": "^4.1.0",
"js-yaml": "^4.3.0",
"prettier": "3.2.5",
"semver": "^7.6.0",
"ts-jest": "^29.0.3",
+4 -4
View File
@@ -3670,10 +3670,10 @@ js-yaml@^3.13.1:
argparse "^1.0.7"
esprima "^4.0.0"
js-yaml@^4.1.0:
version "4.2.0"
resolved "https://registry.npmjs.org/js-yaml/-/js-yaml-4.2.0.tgz"
integrity sha512-ePWsvanv0DWuDRsW8dnt+R4jQ31SCRCQ7hhNcPXZPsoBZiemuZNYGf7adZdqX2D86j6rvKp3RpCxVTSb8WQlOw==
js-yaml@^4.1.0, js-yaml@^4.3.0:
version "4.3.0"
resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.3.0.tgz#d1900572a7f7cf0b5f540c83673e60bad3436592"
integrity sha512-1td788aAnnZ5qs7V2QIRl1owjtYpbKt749Y3xauqQgwIIGF/xXWz1wMTEBx5O3LK3lXLVuqXPdPxj2BoFHaW9Q==
dependencies:
argparse "^2.0.1"