Captain's Log

Overview

The Captain’s Log plugin enables the ability to manage release logs through slack in a Vela pipeline.

Source Code: https://github.com/target/captains-log

Registry: https://hub.docker.com/r/target/captains-log

Usage

Basic Usage

steps:
  - name: captains-log
    image: target/captains-log:1
    pull: always
    secrets: [GITHUB_TOKEN, SLACK_URL]
    parameters:
      github_owner: target
      github_repo: captains-log
      github_tag_id: "v([0-9]+-release)$"
      enterprise_host: https://git.myteam.com
      jira_team_domain: myteamnamespace

Utilize “teams” organization:

steps:
  - name: captains-log
    image: target/captains-log:1
    pull: always
    secrets: [GITHUB_TOKEN, SLACK_URL]
    parameters:
      github_owner: target
      github_repo: captains-log
      github_tag_id: "v([0-9]+-release)$"
      enterprise_host: https://git.myteam.com
      jira_team_domain: myteamnamespace
      teams:
        - name: Team1
          color: "#FFDC18"
          emoji: "✨"
          mentions: "<@person1>  <@person2>"
          issueTracking:
            jira:
              projects:
                - TEAM1
                - TEAM1SUBGROUP
        - name: Team2
          color: "#F48642"
          emoji: "🔥"
          mentions: "<@person3>"
          issueTracking:
            jira:
              projects:
                - TEAM2

Secrets

Users should refrain from configuring sensitive information in their pipeline in plain text.

The plugin accepts the following parameters for authentication:

Parameter	Environment Variable Configuration
`github_token`	`GITHUB_TOKEN`
`slack_token`	`SLACK_URL`
`slack_url`	`SLACK_TOKEN`

Users can use Vela secrets to substitute these sensitive values at runtime:

steps:
  - name: captains-log
    image: target/captains-log:1
    pull: always
+   secrets: [ github_token, slack_url ]
    parameters:
      github_owner: target
      github_repo: captains-log
      github_tag_id: "v([0-9]+-release)$"
      enterprise_host: https://git.myteam.com
      jira_team_domain: myteamnamespace
-     github_token: superSecretToken
-     slack_url: https://hooks.slack.com/services/super/secret/url

This example will add the secrets to the captains-log step as environment variables:

GITHUB_TOKEN=
SLACK_URL=

Parameters

For more on configuration options, visit the Captain’s Log documentation.

https://target.github.io/captains-log/#/configuration/

Last modified June 3, 2021: refactor: replace concepts with tour (#207) (aa0aceac)