https://github.com/containrrr/shoutrrr-action

Notifications using Shoutrrr in GitHub Actions
https://github.com/containrrr/shoutrrr-action

continuous-integration github-actions hacktoberfest notifications shoutrrr

Last synced: about 2 months ago
JSON representation

Notifications using Shoutrrr in GitHub Actions

• Host: GitHub
• URL: https://github.com/containrrr/shoutrrr-action
• Owner: containrrr
• License: mit
• Created: 2021-06-14T13:50:06.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-04-08T10:35:32.000Z (9 months ago)
• Last Synced: 2024-04-08T11:42:26.091Z (9 months ago)
• Topics: continuous-integration, github-actions, hacktoberfest, notifications, shoutrrr
• Language: Dockerfile
• Homepage: https://github.com/marketplace/actions/shoutrrr-action
• Size: 119 KB
• Stars: 13
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        
# Notifications using Shoutrrr in GitHub Actions

With this action, you can send notifications using

[Shoutrrr](https://containrrr.dev/shoutrrr) from your GitHub Actions

workflows.

Let's give an example:

```yaml

name: Deploy

on:

  push:

    branches:

      - main

jobs:

  build:

    runs-on: ubuntu-latest

    steps:

      - name: Some other steps needed for deploying

        run: ...

      - name: Shoutrrr

        uses: containrrr/shoutrrr-action@v1

        with:

          url: ${{ secrets.SHOUTRRR_URL }}

          title: Deployed ${{ github.sha }}

          message: See changes at ${{ github.event.compare }}.

```

The `url` is the Shoutrrr service URL as described in the [service

overview](https://containrrr.dev/shoutrrr/services/overview/). Service

URLs usually contains tokens or other information you should keep

confidential, so make sure you store the URL or at least the secret

parts of the URL in a GitHub secret.

Not all services support the `title` option. It's optional and you can

leave it out.