Skip to content

Commit aa968bb

Browse files
committed
docs: fix trello/trello-github-integ plugin doc issues
1 parent 333fae6 commit aa968bb

File tree

2 files changed

+50
-88
lines changed

2 files changed

+50
-88
lines changed

docs/plugins/trello-github-integ_plugin.md

Lines changed: 24 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -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
1012
tools:
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

6853
In 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

7358
Pay attention to the `${{ xxx }}` part in the example. `${{ TOOL_NAME.TOOL_KIND.outputs.var}}` is the syntax for using an output.
74-

docs/plugins/trello_plugin.md

Lines changed: 26 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -18,58 +18,36 @@ To create a Trello API key and token, see [here](https://trello.com/app-key).
1818

1919
```yaml
2020
tools:
21-
- name: default
22-
# plugin profile
23-
plugin:
24-
# kind of this plugin
25-
kind: trello
26-
# version of the plugin
27-
version: 0.2.0
28-
# options for the plugin, checkout the version from the GitHub releases
29-
options:
30-
# the repo's owner (if kanbanBoardName is empty, use owner/repo as the boardname)
31-
owner: lfbdev
32-
# the repo name (if kanbanBoardName is empty, use owner/repo as the boardname)
33-
repo: golang-demo
34-
# the Tello board name
35-
kanbanBoardName: kanban-name
21+
- name: my-trello-board
22+
# plugin profile
23+
plugin:
24+
# kind of this plugin
25+
kind: trello
26+
# version of the plugin
27+
version: 0.2.0
28+
# options for the plugin, checkout the version from the GitHub releases
29+
options:
30+
# the repo's owner
31+
owner: YOUR_GITHUB_USERNAME
32+
# for which repo this board will be used
33+
repo: YOUR_REPO_NAME
34+
# the Tello board name. If empty, use owner/repo as the board's name.
35+
kanbanBoardName: KANBAN_BOARD_NAME
3636
```
3737
38-
## 3. Use Together with the `trello-github-integ` Plugin
38+
Replace the following from the config above:
3939
40-
This plugin can be used together with the `trello-github-integ` plugin (see document [here](./trello-github-integ_plugin.md).)
40+
- `YOUR_GITHUB_USERNAME`
41+
- `YOUR_REPO_NAME`
42+
- `KANBAN_BOARD_NAME`
4143

42-
See the example below:
44+
## 3. Outputs
4345

44-
```yaml
45-
---
46-
tools:
47-
- name: trello_init_demo
48-
plugin:
49-
kind: trello
50-
version: 0.2.0
51-
options:
52-
owner: lfbdev
53-
repo: golang-demo
54-
kanbanBoardName: kanban-name
55-
- name: trello_github_integ_demo
56-
plugin:
57-
kind: trello-github-integ
58-
version: 0.2.0
59-
dependsOn: ["trello_init_demo.trello"]
60-
options:
61-
owner: lfbdev
62-
repo: golang-demo
63-
boardId: ${{ trello_init_demo.trello.outputs.boardId }}
64-
todoListId: ${{ trello_init_demo.trello.outputs.todoListId }}
65-
doingListId: ${{ trello_init_demo.trello.outputs.doingListId }}
66-
doneListId: ${{ trello_init_demo.trello.outputs.doneListId }}
67-
branch: main
68-
```
69-
70-
In the example above:
46+
This plugin has four outputs:
7147

72-
- We put `default.trello` as a dependency by using the `dependsOn` keyword.
73-
- We use `default.trello`'s output as input for the `default_trello_github` plugin.
48+
- `boardId`
49+
- `todoListId`
50+
- `doingListId`
51+
- `doneListId`
7452

75-
Pay attention to the `${{ xxx }}` part in the example. `${{ TOOL_NAME.TOOL_KIND.outputs.var}}` is the syntax for using an output.
53+
which can be used by the `trello-github-integ` plugin. Refer to the [`trello-github-integ` plugin doc](./trello-github-integ_plugin.md) for more details.

0 commit comments

Comments
 (0)