@@ -4,11 +4,22 @@ This plugin creates a new GitHub Actions workflow(trello-github-integration) and
44
55## 2 Usage:
66
7- _ This plugin depends on the plugin ` trello ` :_
7+ This plugin depends on and can be used together with the ` trello ` plugin (see document [ here] ( ./trello_plugin.md ) ).
8+
9+ ` trello-github-integ ` plugin can also use ` trello ` plugin's outputs as input. See the example below:
810
911``` yaml
1012tools :
11- - name : trello-github-integ-default
13+ - name : my-trello-board
14+ plugin :
15+ kind : trello
16+ version : 0.2.0
17+ dependsOn : ["demo.github-repo-scaffolding-golang"]
18+ options :
19+ owner : YOUR_GITHUB_USERNAME
20+ repo : YOUR_REPO_NAME
21+ kanbanBoardName : KANBAN_BOARD_NAME
22+ - name : trello-github
1223 # plugin profile
1324 plugin :
1425 # kind of this plugin
@@ -17,58 +28,31 @@ tools:
1728 # checkout the version from the GitHub releases
1829 version : 0.2.0
1930 # optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
20- dependsOn : [ "TRELLO_INSTANCE_NAME .trello" ]
31+ dependsOn : [ "my-trello-board .trello" ]
2132 # options for the plugin
2233 options :
2334 # the repo's owner. It should be case-sensitive here; strictly use your GitHub user name; please change the value below.
2435 owner : YOUR_GITHUB_USERNAME
2536 # the repo where you'd like to setup GitHub Actions; please change the value below.
2637 repo : YOUR_REPO_NAME
2738 # reference parameters come from dependency, their usage will be explained later
28- boardId : ${{ TRELLO_INSTANCE_NAME .trello.outputs.boardId }}
29- todoListId : ${{ TRELLO_INSTANCE_NAME .trello.outputs.todoListId }}
30- doingListId : ${{ TRELLO_INSTANCE_NAME .trello.outputs.doingListId }}
31- doneListId : ${{ TRELLO_INSTANCE_NAME .trello.outputs.doneListId }}
39+ boardId : ${{ my-trello-board .trello.outputs.boardId }}
40+ todoListId : ${{ my-trello-board .trello.outputs.todoListId }}
41+ doingListId : ${{ my-trello-board .trello.outputs.doingListId }}
42+ doneListId : ${{ my-trello-board .trello.outputs.doneListId }}
3243 # main branch of the repo (to which branch the plugin will submit the workflows)
3344 branch : main
3445` ` `
3546
36- ## 3. Use Together with the ` trello` Plugin
47+ Replace the following from the config above:
3748
38- This plugin can be used together with the `trello` plugin (see document [here](./trello_plugin.md).)
39-
40- See the example below :
41-
42- ` ` ` yaml
43- ---
44- tools:
45- - name: trello_init_demo
46- plugin:
47- kind: trello
48- version: 0.2.0
49- options:
50- owner: lfbdev
51- repo: golang-demo
52- kanbanBoardName: kanban-name
53- - name: trello_github_integ_demo
54- plugin:
55- kind: trello-github-integ
56- version: 0.2.0
57- dependsOn: ["trello_init_demo.trello"]
58- options:
59- owner: lfbdev
60- repo: golang-demo
61- boardId: ${{ trello_init_demo.trello.outputs.boardId }}
62- todoListId: ${{ trello_init_demo.trello.outputs.todoListId }}
63- doingListId: ${{ trello_init_demo.trello.outputs.doingListId }}
64- doneListId: ${{ trello_init_demo.trello.outputs.doneListId }}
65- branch: main
66- ` ` `
49+ - ` YOUR_GITHUB_USERNAME`
50+ - ` YOUR_REPO_NAME`
51+ - ` KANBAN_BOARD_NAME`
6752
6853In the example above :
6954
70- - We put `trello_init_demo. trello` as a dependency by using the `dependsOn` keyword .
71- - We use `trello_init_demo. trello`'s output as input for the `trello_github_integ_demo ` plugin.
55+ - We create a Trello board using ` trello` plugin, and the board is marked to be used for repo YOUR_GITHUB_USERNAME/YOUR_REPO_NAME .
56+ - ` trello-github-integ ` plugin depends on `trello` plugin, because we use `trello` plugin 's outputs as the input for the `trello-github-integ ` plugin.
7257
7358Pay attention to the `${{ xxx }}` part in the example. `${{ TOOL_NAME.TOOL_KIND.outputs.var}}` is the syntax for using an output.
74-
0 commit comments