webhookPort: 8080 # Only used in non-heroku environments.
globalConfig:
bitbucketUsername: [email protected]
bitbucketPassword: bitbucketPassword
pivotalApiToken: pivotalApiToken
logger:
loglevel: debug # debug, info, warning, error, fatal, panic
output: stderr # stderr, stdout or path e.g /var/log/bucketal.log
format: text # text or json
slack:
loglevel: warning # debug, info, warning, error, fatal, panic
hookUrl: http://webhooks.slack.com
iconEmoji: ":shitbucket:"
channel: "#bucketal"
username: "bucketalbot"
projects:
- projectName: CrossFit Android
tasks: # AddBlocker, ResolveBlocker, FinishFeature, AcceptDeliver, MirrorAcceptance
- AddBlocker
- ResolveBlocker
- FinishFeature
- AcceptDeliver
- MirrorAcceptance
bitbucketRepoName: crossfit-games-android
bitbucketOwner: prolificinteractive
pivotalProjectId: 2102487
# Optional
# Example of a per project configuration. By default it uses the configuration
# from globalConfig. Can be used to specify per project logs slack channel or
# per project authentication credentials for bitbucket and PivotalTracker.
config:
bitbucketUsername: [email protected]
bitbucketPassword: bitbucketPassword
pivotalApiToken: pivotalApiToken
logger:
loglevel: debug
- projectName: Geocoder
tasks:
- AddBlocker
- ResolveBlocker
- FinishFeature
- AcceptDeliver
- MirrorAcceptance
bitbucketRepoName: geocoder
bitbucketOwner: prolificinteractive
pivotalProjectId: <pivotalApiToken>
config:
logger:
loglevel: warning # debug, info, warning, error, fatal, panic
hookUrl: http://custom.webhooks.slack.com
iconEmoji: ":geocoder:"
channel: "#geocoder-bucketal"
username: "geocoderbucketalbot"
# Example of how to configure the template for blockers and
# and comments generatedby this program.
#blockerTemplate: |-
# Waiting on code review [Link]({{ .PR.Links.HTML.Href }})
#commentTemplate: |-
# [ {{ .Story.Type }}: {{ .Story.Name }}]({{ .Story.URL }})
# {{ .Story.Description }}
#
# Automatic Let's Encrypt, switches to webhook port 443 by default
#autoTls:
# domains:
# - www.example.com
| Field | Description | Scheme | Required |
|---|---|---|---|
| globalConfig | Global configuration for all projects | Config | true |
| webhookPort | The port to start the server to recieve webhook events. | int | true |
| autoTLS | Configuration to enable automatic TLS with certificate's provided through Let's Encrypt. | *AutoTLS | false |
| projects | The projects to run Tasks on. | []Project | true |
| Field | Description | Scheme | Required |
|---|---|---|---|
| domains | The domains to request TLS certificates for. | []string | true |
| Field | Description | Scheme | Required |
|---|---|---|---|
| bitbucketUsername | The email address or username of the Bitbucket account to make connections with. | string | true |
| bitbucketPassword | The password of the Bitbucket account to make connections with. | string | true |
| pivotalApiToken | The API token for connecting to Pivotal Tracker. | string | true |
| logger | The configuration for the logging | *Logger | false |
| blockerTemplate | The template for blockers in PivotalTracker. Default: Waiting on code review [Link]({{ .PR.Links.HTML.Href }}) | string | false |
| commentTemplate | The template for comments in Bitbucket. Default: `"[{{ .Story.Type | ToTitle }}: { .Story.Name }}]({{ .Story.URL }}) \n {{ .Story.Description }}` | string |
| Field | Description | Scheme | Required |
|---|---|---|---|
| loglevel | The log level to log at debug, info, warning, panic, fatal. Recommended: debug | string | true |
| output | The destination to log to stderr, stdout or path e.g /var/log/bucketal.log | string | true |
| format | The format of the log text or json | string | true |
| slack | Configuration for logging to Slack. | *Slack | true |
| Field | Description | Scheme | Required |
|---|---|---|---|
| loglevel | The log level to log at debug, info, warning, panic, fatal. Recommended: warning | string | true |
| hookUrl | The webhook URL. ADD LINK | string | true |
| iconEmoji | The icon emoji for for Slack message. | string | true |
| channel | The Slack channel to log to. | string | true |
| username | The username to log Slack message to under. | string | true |
| Field | Description | Scheme | Required |
|---|---|---|---|
| projectName | The name of the project. | string | true |
| tasks | The tasks to perform on the linked Bitbucker repository on the Pivotal Tracker project. | []string | true |
| bitbucketRepoName | The repository name of the project. | string | true |
| bitbucketOwner | The owner of the Bitbucket project. | string | true |
| pivotalProjectId | The projectId of the Pivotal Tracker project connect to. | int | true |
| config | The local configuration for this project. Overrides the global config. | Config | false |
| Task | Description |
|---|---|
| AddBlocker | Adds a blocker on a Pull Request to the Pivotal Tracker story when the Pull Request is created. |
| ResolveBlocker | Resolves the blocker when the Pull Request is merged. |
| FinishFeature | Finishes the linked Pivotal Tracker story when the Pull Request is created. |
| AcceptDeliver | Accepts a chore or Delivers a feature/bug when the Pull Request is merged |
| MirrorAcceptance | Copies the acceptance criterias for a story over into the Pull Request |
Content type
Image
Digest
Size
8.6 MB
Last updated
over 8 years ago
docker pull tevjef/bucketal