Skip to content

Commit bb89b24

Browse files
committed
Update readme, cleanup unused code.
1 parent d229718 commit bb89b24

File tree

3 files changed

+11
-50
lines changed

3 files changed

+11
-50
lines changed

Dockerfile

Lines changed: 0 additions & 24 deletions
This file was deleted.

README.md

Lines changed: 11 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,24 @@
11
# Secure-Webhook
22

3-
Securely call CD servers / notification services after your Action finishes
4-
5-
## Credit
6-
7-
Thanks goes to https://github.com/koraykoska/secure-actions-webhook
3+
Securely call Webhook endpoint after your Action finishes
84

95
## Usage
106

11-
Sending a string:
7+
Sending a json string, ``url``, and ``hmacSecret`` are required fields, and ``data`` is optional.
128

139
```yaml
1410
- name: Webhook
15-
uses: navied/secure-actions-webhook@0.1.3
16-
env:
17-
REQUEST_URI: ${{ secrets.REQUEST_URI }}
18-
REQUEST_DATA: "something_interesting"
19-
HMAC_SECRET: ${{ secrets.HMAC_SECRET }}
11+
uses: navied/secure-actions-webhook@0.2.0
12+
with:
13+
url: https://example.com
14+
data: '{ "example": "data" }'
15+
hmacSecret: ${{ secrets.HMAC_SECRET }}
2016
```
2117
22-
Sending a json string:
18+
The request will include the header `X-Hub-Signature`, which is the hmac signature of the raw body just like in Github webhooks, and also the header `X-Hub-SHA` which is the SHA of the commit running the github action.
2319

24-
```yaml
25-
- name: Webhook
26-
uses: navied/secure-actions-webhook@0.1.3
27-
env:
28-
REQUEST_URI: ${{ secrets.REQUEST_URI }}
29-
REQUEST_DATA: '{ "something": "interesting" }'
30-
HMAC_SECRET: "secret_used_to_generate_signature"
31-
```
20+
Verify it on your endpoint for integrity.
3221

33-
The request will include the header `X-Hub-Signature`, which is the hmac signature of the raw body just like in Github webhooks.
22+
## Credit
3423

35-
Verify it on your endpoint for integrity.
24+
Thanks to https://github.com/koraykoska/secure-actions-webhook for providing the base signature generation code.

entrypoint.sh

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)