Skip to content

Instantly share code, notes, and snippets.

@joho joho/hecate.yml
Last active May 15, 2019

Embed
What would you like to do?
Reference configuration for Hecate Dispatch https://hecate.co/products/dispatch
# Required: an admin contact for errors, billing issues, and the like
admin_email: your.name@yourcompany.com
# 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:
- marketing@yourcompany.com
- customer.support@yourcompany.com
# 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:
- tech.lead@yourcompany.com
rollup: daily
matching:
all: true
-
# Example: Rollup with all the custom settings
emails:
- product.managers@yourcompany.com
# 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

This comment has been minimized.

Copy link

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

This comment has been minimized.

Copy link
Owner Author

commented Jul 18, 2018

@thephw good question - either works!

@jb1b84

This comment has been minimized.

Copy link

commented Jul 26, 2018

Does the slack integration support rollup?

@joho

This comment has been minimized.

Copy link
Owner Author

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

This comment has been minimized.

Copy link

commented Apr 23, 2019

What values work for rollup?

@joho

This comment has been minimized.

Copy link
Owner Author

commented Apr 24, 2019

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.