Sign inSign up

tevjef/bucketal

By tevjef

Updated over 8 years ago

Adds blockers to Pivotal Stories

Image
0

544

tevjef/bucketal repository overview

Config YAML


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

FieldDescriptionSchemeRequired
globalConfigGlobal configuration for all projectsConfigtrue
webhookPortThe port to start the server to recieve webhook events.inttrue
autoTLSConfiguration to enable automatic TLS with certificate's provided through Let's Encrypt.*AutoTLSfalse
projectsThe projects to run Tasks on.[]Projecttrue

AutoTLS

FieldDescriptionSchemeRequired
domainsThe domains to request TLS certificates for.[]stringtrue

Config

FieldDescriptionSchemeRequired
bitbucketUsernameThe email address or username of the Bitbucket account to make connections with.stringtrue
bitbucketPasswordThe password of the Bitbucket account to make connections with.stringtrue
pivotalApiTokenThe API token for connecting to Pivotal Tracker.stringtrue
loggerThe configuration for the logging*Loggerfalse
blockerTemplateThe template for blockers in PivotalTracker. Default: Waiting on code review [Link]({{ .PR.Links.HTML.Href }})stringfalse
commentTemplateThe template for comments in Bitbucket. Default: `"[{{ .Story.TypeToTitle }}: { .Story.Name }}]({{ .Story.URL }}) \n {{ .Story.Description }}`string

Logger

FieldDescriptionSchemeRequired
loglevelThe log level to log at debug, info, warning, panic, fatal. Recommended: debugstringtrue
outputThe destination to log to stderr, stdout or path e.g /var/log/bucketal.logstringtrue
formatThe format of the log text or jsonstringtrue
slackConfiguration for logging to Slack.*Slacktrue

Slack

FieldDescriptionSchemeRequired
loglevelThe log level to log at debug, info, warning, panic, fatal. Recommended: warningstringtrue
hookUrlThe webhook URL. ADD LINKstringtrue
iconEmojiThe icon emoji for for Slack message.stringtrue
channelThe Slack channel to log to.stringtrue
usernameThe username to log Slack message to under.stringtrue

Project

FieldDescriptionSchemeRequired
projectNameThe name of the project.stringtrue
tasksThe tasks to perform on the linked Bitbucker repository on the Pivotal Tracker project.[]stringtrue
bitbucketRepoNameThe repository name of the project.stringtrue
bitbucketOwnerThe owner of the Bitbucket project.stringtrue
pivotalProjectIdThe projectId of the Pivotal Tracker project connect to.inttrue
configThe local configuration for this project. Overrides the global config.Configfalse

Task

TaskDescription
AddBlockerAdds a blocker on a Pull Request to the Pivotal Tracker story when the Pull Request is created.
ResolveBlockerResolves the blocker when the Pull Request is merged.
FinishFeatureFinishes the linked Pivotal Tracker story when the Pull Request is created.
AcceptDeliverAccepts a chore or Delivers a feature/bug when the Pull Request is merged
MirrorAcceptanceCopies the acceptance criterias for a story over into the Pull Request

Tag summary

Content type

Image

Digest

Size

8.6 MB

Last updated

over 8 years ago

docker pull tevjef/bucketal