From b103caf9d410b59afbd2f04b1670c1afeaf48f09 Mon Sep 17 00:00:00 2001
From: ksurl <ksurl@users.noreply.github.com>
Date: Sat, 12 Nov 2022 13:05:19 -0800
Subject: [PATCH] add github actions example

---
 docs/examples.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/docs/examples.md b/docs/examples.md
index 4ac7a4b2..b9adf443 100644
--- a/docs/examples.md
+++ b/docs/examples.md
@@ -122,6 +122,19 @@ to ntfy at its default URL (`attrs` and other attributes are optional):
           priority: 1
 ```
 
+## GitHub Actions
+You can send a message during a workflow run with curl. Here is an example sending info about the repo, commit and job status.
+``` yaml
+- name: Actions Ntfy
+  run: |
+    curl \
+      -u ${{ secrets.NTFY_CRED }} \
+      -H "Title: Title here" \
+      -H "Content-Type: text/plain" \
+      -d $'Repo: ${{ github.repository }}\nCommit: ${{ github.sha }}\nRef: ${{ github.ref }}\nStatus: ${{ job.status}}' \
+      ${{ secrets.NTFY_URL }}
+```
+
 ## Watchtower (shoutrrr)
 You can use [shoutrrr](https://github.com/containrrr/shoutrrr) generic webhook support to send 
 [Watchtower](https://github.com/containrrr/watchtower/) notifications to your ntfy topic.