Skip to content

trello Plugin

This plugin integrates Trello with your GitHub repo.

Usage

The following content is an example of the "tool file".

For more information on the main config, the tool file, and the var file of DevStream, see Core Concepts Overview and DevStream Configuration.

YAML
tools:
# name of the tool
- name: trello
  # id of the tool instance
  instanceID: default
  # format: name.instanceID; If specified, dtm will make sure the dependency is applied first before handling this tool
  dependsOn: [ ]
  # options for the plugin
  options:
    # the repo's owner
    board:
      # the Trello board name. If empty, use owner/name as the board's name.
      name: KANBAN_BOARD_NAME
      # the Trello board description. If empty, use devstream's default description
      description: KANBAN_DESCRIPTION
      # Trello apiKey and token, see https://docs.servicenow.com/bundle/quebec-it-asset-management/page/product/software-asset-management2/task/generate-trello-apikey-token.html for more information
      apikey: [[ env TRELLO_API_KEY ]] # use environment variable "TRELLO_API_KEY" to set the value
      token: [[ env TRELLO_TOKEN ]] # use environment variable "TRELLO_TOKEN" to set the value
    scm:
      # scm common field
      branch: YOUR_REPO_BRANCH
      token: [[ env GITHUB_TOKEN ]] # use environment variable "GITHUB_TOKEN" to set the value
      # you can directly use the url of repo (git@github.com/root/test-exmaple.git for example)
      url: YOUR_REPO_URL
      # or you can config detailed fields for this repo
      owner: YOUR_REPO_OWNER

Notes:

  • Trello board description is managed by DevStream, please don't modify it.
  • To config a board.token, see here.
  • scm config option represents codebase location; for more info, you can refer to SCM Config.

Outputs

This plugin has four outputs:

  • boardId
  • todoListId
  • doingListId
  • doneListId