From 918b61b61d1559351aa8ff6b66910d17ef802a7b Mon Sep 17 00:00:00 2001 From: kha7iq Date: Tue, 11 May 2021 23:05:00 +0800 Subject: [PATCH] docs: update documentation for mastodon services --- docs/services.md | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) diff --git a/docs/services.md b/docs/services.md index b47ac56..11a5668 100644 --- a/docs/services.md +++ b/docs/services.md @@ -468,6 +468,49 @@ jobs: | TWILLIO_TITLE | "" | | TWILLIO_MESSAGE | "" | +## Mastodon + +Mastodon uses application token to authorize and set status. + +```bash +mastodon --url "mastodon.social" --msg "some message" --title "PingMe CLI" --token "123" +``` + +- GitHub Action + +```yaml +on: [push] + +jobs: + pingme-job: + runs-on: ubuntu-latest + name: PingMe + steps: + - name: Checkout + uses: actions/checkout@v2 + + - name: Ping me On + uses: kha7iq/pingme-action@v1 + env: + MASTODON_TOKEN: ${{ secrets.MASTODON_TOKEN }} + MASTODON_SERVER: 'mastodon.social' + MASTODON_TITLE: 'Reference: ${{ github.ref }}' + MASTODON_MESSAGE: 'Event is triggered by ${{ github.event_name }}' + + with: + service: mastodon +``` + +- **Variables** + +| Variables | Default Value | +| -------------------------- | :----------------: | +| MASTODON_TOKEN | "" | +| MASTODON_SERVER | "" | +| MASTODON_TITLE | "" | +| MASTODON_MESSAGE | "" | + + ## Email Email uses username & password to authenticate for sending emails. SMTP