mirror of
https://github.com/joelwmale/webhook-action.git
synced 2026-10-17 13:02:32 -05:00
Compare commits
5
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
435d77d68a | ||
|
|
e90574c974 | ||
|
|
50f3dc0b06 | ||
|
|
303dbdda5d | ||
|
|
cc1a66f987 |
@@ -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.
|
||||||
|
|
||||||
@@ -47,14 +50,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 +66,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 +77,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 +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
|
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 +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
|
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 +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
|
||||||
[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
|
||||||
|
|||||||
Generated
+11
-17
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "webhook-action",
|
"name": "webhook-action",
|
||||||
"version": "2.4.1",
|
"version": "2.4.2",
|
||||||
"lockfileVersion": 3,
|
"lockfileVersion": 3,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "webhook-action",
|
"name": "webhook-action",
|
||||||
"version": "2.4.1",
|
"version": "2.4.2",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/core": "^2.0.3",
|
"@actions/core": "^2.0.3",
|
||||||
@@ -26,7 +26,7 @@
|
|||||||
"eslint-plugin-jest": "^27.9.0",
|
"eslint-plugin-jest": "^27.9.0",
|
||||||
"https": "^1.0.0",
|
"https": "^1.0.0",
|
||||||
"jest": "^29.7.0",
|
"jest": "^29.7.0",
|
||||||
"js-yaml": "^4.1.0",
|
"js-yaml": "^4.3.2",
|
||||||
"prettier": "3.2.5",
|
"prettier": "3.2.5",
|
||||||
"semver": "^7.6.0",
|
"semver": "^7.6.0",
|
||||||
"ts-jest": "^29.0.3",
|
"ts-jest": "^29.0.3",
|
||||||
@@ -92,14 +92,6 @@
|
|||||||
"undici": "^6.23.0"
|
"undici": "^6.23.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@actions/github/node_modules/@actions/http-client/node_modules/undici": {
|
|
||||||
"version": "6.26.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/undici/-/undici-6.26.0.tgz",
|
|
||||||
"integrity": "sha512-4yqz8a3n5HmGTlsbADNtr/dJlhkh/55Rq798G6ibiULcXbDtaLpTl1pvdqcbFfeoj3iSi52lePFM7h9H21cw/A==",
|
|
||||||
"engines": {
|
|
||||||
"node": ">=18.17"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"node_modules/@actions/http-client": {
|
"node_modules/@actions/http-client": {
|
||||||
"version": "4.0.1",
|
"version": "4.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-4.0.1.tgz",
|
"resolved": "https://registry.npmjs.org/@actions/http-client/-/http-client-4.0.1.tgz",
|
||||||
@@ -2000,10 +1992,11 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/@istanbuljs/load-nyc-config/node_modules/js-yaml": {
|
"node_modules/@istanbuljs/load-nyc-config/node_modules/js-yaml": {
|
||||||
"version": "3.14.2",
|
"version": "3.15.2",
|
||||||
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.2.tgz",
|
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.15.2.tgz",
|
||||||
"integrity": "sha512-PMSmkqxr106Xa156c2M265Z+FTrPl+oxd/rgOQy2tijQeK5TxQ43psO1ZCwhVOSdnn+RzkzlRz/eY4BgJBYVpg==",
|
"integrity": "sha512-6EuL879VkRA+1Cz578mKMiKvjPNEuk6+r1JaFzoSWejZmtf7xWbIyw1e3KkxlkzTIt9Taw6JBhEppG7utc1P+w==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"argparse": "^1.0.7",
|
"argparse": "^1.0.7",
|
||||||
"esprima": "^4.0.0"
|
"esprima": "^4.0.0"
|
||||||
@@ -8069,9 +8062,9 @@
|
|||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"node_modules/js-yaml": {
|
"node_modules/js-yaml": {
|
||||||
"version": "4.2.0",
|
"version": "4.3.2",
|
||||||
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.2.0.tgz",
|
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-4.3.2.tgz",
|
||||||
"integrity": "sha512-ePWsvanv0DWuDRsW8dnt+R4jQ31SCRCQ7hhNcPXZPsoBZiemuZNYGf7adZdqX2D86j6rvKp3RpCxVTSb8WQlOw==",
|
"integrity": "sha512-SFNOvSJ+Dgf/9An904Yx+CgSlIPCkIpao4qo51lpee25TIRejdH3rhR4EZMGoNx3/TP3O+wzWuiTFl4sqbltzA==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"funding": [
|
"funding": [
|
||||||
{
|
{
|
||||||
@@ -8083,6 +8076,7 @@
|
|||||||
"url": "https://github.com/sponsors/nodeca"
|
"url": "https://github.com/sponsors/nodeca"
|
||||||
}
|
}
|
||||||
],
|
],
|
||||||
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"argparse": "^2.0.1"
|
"argparse": "^2.0.1"
|
||||||
},
|
},
|
||||||
|
|||||||
+2
-2
@@ -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": {
|
||||||
@@ -42,7 +42,7 @@
|
|||||||
"eslint-plugin-jest": "^27.9.0",
|
"eslint-plugin-jest": "^27.9.0",
|
||||||
"https": "^1.0.0",
|
"https": "^1.0.0",
|
||||||
"jest": "^29.7.0",
|
"jest": "^29.7.0",
|
||||||
"js-yaml": "^4.1.0",
|
"js-yaml": "^4.3.2",
|
||||||
"prettier": "3.2.5",
|
"prettier": "3.2.5",
|
||||||
"semver": "^7.6.0",
|
"semver": "^7.6.0",
|
||||||
"ts-jest": "^29.0.3",
|
"ts-jest": "^29.0.3",
|
||||||
|
|||||||
@@ -3670,10 +3670,10 @@ js-yaml@^3.13.1:
|
|||||||
argparse "^1.0.7"
|
argparse "^1.0.7"
|
||||||
esprima "^4.0.0"
|
esprima "^4.0.0"
|
||||||
|
|
||||||
js-yaml@^4.1.0:
|
js-yaml@^4.1.0, js-yaml@^4.3.2:
|
||||||
version "4.2.0"
|
version "4.3.2"
|
||||||
resolved "https://registry.npmjs.org/js-yaml/-/js-yaml-4.2.0.tgz"
|
resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-4.3.2.tgz#8e44fb14a2643c59726bb15787b5f1512cb3d3fb"
|
||||||
integrity sha512-ePWsvanv0DWuDRsW8dnt+R4jQ31SCRCQ7hhNcPXZPsoBZiemuZNYGf7adZdqX2D86j6rvKp3RpCxVTSb8WQlOw==
|
integrity sha512-SFNOvSJ+Dgf/9An904Yx+CgSlIPCkIpao4qo51lpee25TIRejdH3rhR4EZMGoNx3/TP3O+wzWuiTFl4sqbltzA==
|
||||||
dependencies:
|
dependencies:
|
||||||
argparse "^2.0.1"
|
argparse "^2.0.1"
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user