mirror of
https://github.com/Clortox/drone-ntfy.git
synced 2026-03-15 05:58:00 +00:00
Compare commits
5 Commits
Dev
...
pipeline-r
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
58d59d7aec | ||
|
|
7ab1061904 | ||
|
|
4bab19d289 | ||
|
|
0ca6b05d20 | ||
|
|
cd40495ff4 |
@@ -26,3 +26,6 @@ steps:
|
|||||||
MESSAGE: Drone-ntfy has finished building!
|
MESSAGE: Drone-ntfy has finished building!
|
||||||
CLICK: https://drone.clortox.com/tyler/drone-ntfy
|
CLICK: https://drone.clortox.com/tyler/drone-ntfy
|
||||||
TITLE: Drone (drone-ntfy)
|
TITLE: Drone (drone-ntfy)
|
||||||
|
when:
|
||||||
|
branch:
|
||||||
|
- main
|
||||||
|
|||||||
39
README.md
39
README.md
@@ -2,5 +2,44 @@
|
|||||||
|
|
||||||
A [Drone](https://drone.io) plugin for ntfy.
|
A [Drone](https://drone.io) plugin for ntfy.
|
||||||
|
|
||||||
|
## Example
|
||||||
|
|
||||||
|
The following is an example pipeline where we only send a notification
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
steps:
|
||||||
|
- name:
|
||||||
|
image: clortox/drone-ntfy
|
||||||
|
settings:
|
||||||
|
URL: https://ntfy.clortox.com
|
||||||
|
USERNAME: drone
|
||||||
|
PASSWORD:
|
||||||
|
from_secret: ntfy_password
|
||||||
|
TOPIC: drone-builds
|
||||||
|
MESSAGE: Drone build done!
|
||||||
|
CLICK: https://drone.clortox.com/tyler/drone-ntfy
|
||||||
|
TITLE: Drone (Drone-ntfy)
|
||||||
|
```
|
||||||
|
|
||||||
|
A living, breathing example of this is in this repository's [drone file](.drone.yml).
|
||||||
|
|
||||||
|
## Options
|
||||||
|
|
||||||
|
There are several options that you can configure when sending the notification.
|
||||||
|
Note that the `ntfy Name` is the name you will use in the settings section of
|
||||||
|
your configuration.
|
||||||
|
|
||||||
|
| ntfy Name | Container Environment Variable | Default Value | Description |
|
||||||
|
| -------- | ------ | ----- | ----------- |
|
||||||
|
| Priority | PLUGIN_PRIORITY | N/A | Notification Priority |
|
||||||
|
| Title | PLUGIN_TITLE | N/A | Title of the notification |
|
||||||
|
| Tags | PLUGIN_TAGS | N/A | Emojis on the notification |
|
||||||
|
| Click | PLUGIN_CLICK | N/A | URL to navigate to if the user clicks the notification |
|
||||||
|
| Attach (TODO) | PLUGIN_ATTACH | N/A | URL or localfile to attach |
|
||||||
|
| Icon (TODO) | PLUGIN_ICON | N/A | Icon to display |
|
||||||
|
| URL | PLUGIN_URL | ntfy.sh | URL to send the notification to |
|
||||||
|
| Topic | PLUGIN_TOPIC | drone-notifications | The notification top to send this to |
|
||||||
|
| Message | PLUGIN_MESSAGE | Pipeline Finished! | The body of the notification |
|
||||||
|
| Username | PLUGIN_USERNAME | N/A | The username to authenticate with |
|
||||||
|
| Password | PLUGIN_PASSWORD | N/A | The password to authenticate with |
|
||||||
|
|
||||||
|
|||||||
13
main.sh
13
main.sh
@@ -6,7 +6,6 @@ Priority=${PLUGIN_PRIORITY:-}
|
|||||||
Title=${PLUGIN_TITLE:-}
|
Title=${PLUGIN_TITLE:-}
|
||||||
Tags=${PLUGIN_TAGS:-}
|
Tags=${PLUGIN_TAGS:-}
|
||||||
Click=${PLUGIN_CLICK:-}
|
Click=${PLUGIN_CLICK:-}
|
||||||
|
|
||||||
Attach=${PLUGIN_ATTACH:-}
|
Attach=${PLUGIN_ATTACH:-}
|
||||||
Icon=${PLUGIN_ICON:-}
|
Icon=${PLUGIN_ICON:-}
|
||||||
|
|
||||||
@@ -33,5 +32,13 @@ if [[ ! -z $Click ]]; then
|
|||||||
Click="-H Click:$Click"
|
Click="-H Click:$Click"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
curl $Priority $Title $Tags $Click -u $Username:$Password -d "$Message" $URL/$Topic
|
if [[ ! -z $Attach ]]; then
|
||||||
#echo curl $Priority $Title $Tags $Click -u $Username:$Password -d "$Message" $URL/$Topic
|
Attach="-H Attach:$Attach"
|
||||||
|
fi
|
||||||
|
|
||||||
|
if [[ ! -z $Icon ]]; then
|
||||||
|
Icon="-H Icon:$Icon"
|
||||||
|
fi
|
||||||
|
|
||||||
|
curl $Priority $Title $Tags $Click $Attach $Icon -u $Username:$Password -d "$Message" $URL/$Topic
|
||||||
|
#curl $Priority $Title $Tags $Click $Attach $Icon -u $Username:$Password -d "$Message" $URL/$Topic
|
||||||
|
|||||||
Reference in New Issue
Block a user