Drone CI Plugin. Notify events via Ntfy.sh
Go to file
parra 7dc1ee294d
continuous-integration/drone/push Build is passing Details
continuous-integration/drone/tag Build is passing Details
[Fix] Split repo name from build in title (#4)
Reviewed-on: #4
Co-authored-by: parra <victor+git@parravidales.es>
Co-committed-by: parra <victor+git@parravidales.es>
2023-10-28 18:14:53 +02:00
cmd/drone-ntfy [Fix] Split repo name from build in title (#4) 2023-10-28 18:14:53 +02:00
pkg/model Naming refactor 2023-03-15 20:38:50 +01:00
.drone.yml Naming refactor 2023-03-15 20:38:50 +01:00
.gitignore Migrate project to Go 2023-02-23 21:30:10 +01:00
Dockerfile Migrate project to Go 2023-02-23 21:30:10 +01:00
README.md Add Repo Name in notification title (#3) 2023-10-28 18:12:13 +02:00
go.mod Migrate project to Go 2023-02-23 21:30:10 +01:00
go.sum Migrate project to Go 2023-02-23 21:30:10 +01:00

README.md

Drone Ntfy plugin

Build Status

The Ntfy.sh plugin posts build status messages to your selected Ntfy server.

Example:

kind: pipeline
name: default

steps:
- name: send ntfy notification
  image: parrazam/drone-ntfy
  when:
      status: [success, failure]
  settings:
    url: https://ntfy.example.org
    topic: events
    priority: low
    tags:
      - pipeline-status
      - dev
    token:
      from_secret: ntfy_token

Properties

url string [optional]
Ntfy server.

Default: https://ntfy.sh

topic string [REQUIRED]
Topic to publish message.

Default: none

priority string [optional]
Priority of the notification. Values can be [min, low, default, high, max].

Default: default

tags string [optional]
Custom tags to include.

Default: none

username string [optional]
Username with publish permissions.

Default: none

password string [optional]
[SECRET RECOMMENDED]
Password for username.

Default: none

token string [optional]
[SECRET RECOMMENDED]
Token to use, instead username and password.

Default: none

Development

If you want to test the project locally, first you need to create an .env file with:

PLUGIN_TOPIC=
PLUGIN_URL=
PLUGIN_USERNAME=
PLUGIN_PASSWORD=
PLUGIN_TOKEN=
CI_COMMIT_SHA=
CI_COMMIT_MESSAGE=
CI_REPO_NAME=
CI_COMMIT_BRANCH=
CI_COMMIT_REF=
DRONE_BUILD_NUMBER=
DRONE_BUILD_STATUS=
DRONE_STAGE_NUMBER=
DRONE_STAGE_STATUS=
DRONE_TAG=
DRONE_BUILD_LINK=
DRONE_COMMIT_LINK=
DRONE_REPO_NAME=