From 50f3dc0b06625a68681ddb0ee36a6f7923d7b597 Mon Sep 17 00:00:00 2001 From: Joel Male Date: Tue, 2 Jun 2026 16:26:47 +1000 Subject: [PATCH] chore: bump version to 2.4.2 and update README to use semver tags --- README.md | 44 +++++++++++++++++++++++--------------------- package.json | 2 +- 2 files changed, 24 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index d9b9070d..12f97b28 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,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 +23,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 +49,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 +65,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 +76,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 +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 -```yml - insecure: true +```yml +insecure: true ``` #### 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 -```yml - github_event_payload: true +```yml +github_event_payload: true ``` ## 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-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg -[link-github-release]: https://github.com/joelwmale/webhook-action/releases \ No newline at end of file +[link-github-release]: https://github.com/joelwmale/webhook-action/releases diff --git a/package.json b/package.json index 2f9b3709..cbd11d6b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "webhook-action", - "version": "2.4.1", + "version": "2.4.2", "description": "Github Webhook Action", "main": "dist/main.js", "scripts": {