Home

Awesome

action-bark

Allow GitHub Actions to push iOS notifications via Bark

Quick Start

steps:
  - uses: harryzcy/action-bark@v1
    with:
        status: ${{ job.status }}
        device_key: ${{ secrets.BARK_DEVICE_KEY }}
        bark_server_url: ${{ secrets.BARK_SERVER_URL }}
    if: always() # Pick up events even if the job fails or is canceled.

Advanced Usage

More controls over notifications:

steps:
  - uses: harryzcy/action-bark@v1
    with:
        status: ${{ job.status }}
        on_status: failure, cancelled # only run on these status
        device_key: ${{ secrets.BARK_DEVICE_KEY }}
        level: passive # iOS notification level 'active', 'timeSensitive' or 'passive', default to 'active'
        bark_server_url: ${{ secrets.BARK_SERVER_URL }}
    if: always() # Pick up events even if the job fails or is canceled.

Custom title and body:

steps:
  - uses: harryzcy/action-bark@v1
    with:
        status: ${{ job.status }}
        title: custom title
        body: custom body
        device_key: ${{ secrets.BARK_DEVICE_KEY }}
        level: passive # iOS notification level 'active', 'timeSensitive' or 'passive', default to 'active'
        bark_server_url: ${{ secrets.BARK_SERVER_URL }}
    if: always() # Pick up events even if the job fails or is canceled.

Github Enterprise Users

steps:
  - uses: harryzcy/action-bark@v1
    with:
        status: ${{ job.status }}
        device_key: ${{ secrets.BARK_DEVICE_KEY }}
        bark_server_url: ${{ secrets.BARK_SERVER_URL }}
        github_server_url: https://your.ghe.com # Specify your GHE
    if: always() # Pick up events even if the job fails or is canceled.

Inputs

InputDescriptionRequired
titleSpecify a custom title of the notification, required if status is set to customfalse
bodySpecify a custom body of the notification, required if status is set to customfalse
device_keySpecify Bark device key of your devicetrue
levelSpecify iOS notification level (default: active)false
badgeThe number displayed next to App iconfalse
automatically_copyAutomatically copy the content to the clipboard (must be "1" if set)false
copyThe content to be copied to the clipboardfalse
soundSound to be played, value from https://github.com/Finb/Bark/tree/master/Soundsfalse
iconAn url to the icon, available only on iOS 15 or laterfalse
groupThe group of the notificationfalse
is_archiveValue must be "1". Whether or not should be archived by the appfalse
urlThe url to be opened when the notification is clicked (defaults to GitHub run URL)false
bark_server_urlSpecify your Bark server URLtrue
github_server_urlSpecify your GitHub Enterprise URLfalse