GoCD Spark Build Notifier

CiscoSpark based GoCD build notifier

Setup

Download jar from releases & place it in /plugins/external & restart Go Server.

Configuration

All configurations are in HOCON format. Plugin searches for the configuration file in the following order

1. File defined by the environment variable GO_NOTIFY_CONF.
2. go_notify.conf at the user's home directory. Typically it's the go user's home directory (/var/go).
3. go_notify.conf present at the CRUISE_SERVER_DIR environment variable location.

Minimalistic configuration would be something like

gocd.spark {
  login = "gocd_user"
  password = "gocd_password"
  server-host = "http://localhost:8153/"
  api-server-host = "http://localhost:8153/"
  
  # Spark fields
  bearerToken = "vmGKT5YmpnYmryykWyJCRNPccLO4OkSPw3yNvoW2O0vLrZaBBDif2Gvz7aTX8jcx"
  webhookUrl = "https://example.com/webhook/..."
  webhookSecret = "w3yNvoW2O0vLrZaBBDif2Gvz7aTX8jcx"

  # optional fields
  room = "f9d5fc50-c80b-3485-925f-88d8b47e8a75"
  sparkDisplayName = "gocd-spark-bot"
  sparkUserIconURL = "http://example.com/spark-bot.png"
  display-console-log-links = true
  displayMaterialChanges = true
  process-all-rules = true
}

• login - Login for a Go user who is authorized to access the REST API.
• password - Password for the user specified above. You might want to create a less privileged user for this plugin.
• server-host - FQDN of the Go Server. All links on the spark channel will be relative to this host.
• api-server-host - This is an optional attribute. Set this field to localhost so server will use this endpoint to get PipelineHistory and PipelineInstance
• bearerToken - Bearer/Access token for your Spark Bot (https://developer.ciscospark.com/bot-detail.html)
• webhookUrl - Custom Cisco Spark Webhook URL (https://developer.ciscospark.com/resource-webhooks.html)
• room - Override the default room where we should send the notifications in spark.
• display-console-log-links - Display console log links in the notification. Defaults to true, set to false if you want to hide.
• displayMaterialChanges - Display material changes in the notification (git revisions for example). Defaults to true, set to false if you want to hide.
• process-all-rules - If true, all matching rules are applied instead of just the first.
• truncate-changes - If true, displays only the latest 5 changes for all the materials. (Default: true)

In order to get your bearer/access token you need to create a bot. Your bots bearer token will be available after you've created it.

For your room ID, simply add the new bot to a room and note down the room ID from the browser URL.

Pipeline Rules

By default the plugin pushes a note about all failed stages across all pipelines to Spark. You have fine grain control over this operation.

gocd.spark {
  server-host = "http://localhost:8153/"
  webhookUrl = "https://example.com/webhook/..."

  pipelines = [{
    name = "gocd-spark-build"
    stage = "build"
    group = ".*"
    state = "failed|passed"
    room = "f9d5fc50-c80b-3485-925f-88d8b47e8a75"
    owners = ["t04glovern"]
    webhookUrl = "https://example.com/webhook/..."
  },
  {
    name = ".*"
    stage = ".*"
    state = "failed"
  }]
}

gocd.spark.pipelines contains all the rules for the go-server. It is a list of rules (see below for what the parameters mean) for various pipelines. The plugin will pick the first matching pipeline rule from the pipelines collection above, so your most specific rule should be first, with the most generic rule at the bottom. Alternatively, set the process-all-rules option to true and all matching rules will be applied.

• name - Regex to match the pipeline name
• stage - Regex to match the stage name
• group - Regex to match the pipeline group name
• state - State of the pipeline at which we should send a notification. You can provide multiple values separated by pipe (|) symbol. Valid values are passed, failed, cancelled, building, fixed, broken or all.
• room - (Optional) room where we should send the spark notification. This setting for a rule overrides the global setting
• owners - (Optional) list of spark user handles who must be tagged in the message upon notifications
• webhookUrl - (Optional) Use this webhook url instead of the global one. Useful if you're using multiple spark teams.

Images

License

http://www.apache.org/licenses/LICENSE-2.0