Skip to content

Instantly share code, notes, and snippets.

@joho
Last active July 13, 2022 10:17
Show Gist options
  • Save joho/7d630b73fefc3b1622a25d91e4d0e94c to your computer and use it in GitHub Desktop.
Save joho/7d630b73fefc3b1622a25d91e4d0e94c to your computer and use it in GitHub Desktop.
Reference configuration for Hecate Dispatch https://hecate.co/products/dispatch
# Required: an admin contact for errors, billing issues, and the like
admin_email: [email protected]
# Optional: timezone for when to send and how to format emails
# defaults to "Australia/Melbourne"
timezone: "Australia/Melbourne"
# Required: config for shipping news (notify on merged PRs)
shipping:
# Array of release notifications to send
-
# Example: Instant email on pull request merge
emails:
- [email protected]
- [email protected]
# Required: config for which repos to listen to
matching:
# Manually whitelist repos
whitelist: ["product", "other-product"]
# Optional: notify only on merges to this branch
# default is any branch (ie all merges)
base_branch: develop
-
# Example: Standard daily rollup, send all releases
# over all repos in a daily summary
# sent at 8am in your timezone
emails:
- [email protected]
rollup: daily
matching:
all: true
-
# Example: Rollup with all the custom settings
emails:
- [email protected]
# Optional: switches from live updates to rollup
# valid values are daily and weekly
rollup: daily
# Optional: per notification timezone override
timezone: "America/Los_Angeles"
# Optional: don't send on weekends and
# hold updates for Monday morning.
# defaults to true
weekends_matter: false
# Optional: hour of the day to send rollup (0..23)
# default 8
hour_of_day: 13
matching:
# All repos you granted access to via Github
all: true
# Exclude PRs with the following labels
excluding_labels: ["tech-debt", "ops"]
-
# Example: Slack notifications of merges
# To enable visit https://app.hecate.co/,
# login with GitHub Oauth, and click the
# "Add to Slack" button on the settings page
slack_channels: ["releases"]
matching:
whitelist: ["product"]
-
# Example: Instant email when label added to PR
emails: ["marketing.department"]
# Optional: labelled or merged (default merged)
trigger: labelled
matching:
all: true
labels: ["for-announcement"]
@thephw
Copy link

thephw commented Jul 10, 2018

The whitelist array need the organization slug? i.e. definc/some_repo or it assumed the organization from the location of the config?

@joho
Copy link
Author

joho commented Jul 18, 2018

@thephw good question - either works!

@jb1b84
Copy link

jb1b84 commented Jul 26, 2018

Does the slack integration support rollup?

@joho
Copy link
Author

joho commented Jul 27, 2018

@jb1b84 not yet but I am working on it, trying to find the right UX for it as for some of our customers it can get quite long.

@thephw
Copy link

thephw commented Apr 23, 2019

What values work for rollup?

@joho
Copy link
Author

joho commented Apr 24, 2019

Right now it's only daily but happy to add weekly if the demand is there.

@guhou
Copy link

guhou commented May 21, 2019

Can Slack notifications be sent as DMs as well as to channels?

@yhhi
Copy link

yhhi commented Jul 13, 2022

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment