Skip to content

Commit 815ebe0

Browse files
authored
Merge pull request #416 from merico-dev/fix-config
chore: adding the missing config field for most plugins.
2 parents 202d501 + 4fe9aca commit 815ebe0

22 files changed

+90
-45
lines changed

docs/plugins/argocd.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ tools:
99
- name: argocd
1010
# name of the plugin
1111
plugin: argocd
12+
# if specified, dtm will make sure the dependency is applied first before handling this tool.
13+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
14+
# options for the plugin
1215
options:
1316
# need to create the namespace or not, default: false
1417
create_namespace: true

docs/plugins/devlake.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ tools:
1111
- name: devlake
1212
# name of the plugin
1313
plugin: devlake
14+
# if specified, dtm will make sure the dependency is applied first before handling this tool.
15+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
1416
```
1517
1618
All the parameters in the example above are mandatory.

docs/plugins/github-repo-scaffolding-golang.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ tools:
2727
- name: go-webapp-repo
2828
# name of the plugin
2929
plugin: github-repo-scaffolding-golang
30+
# if specified, dtm will make sure the dependency is applied first before handling this tool.
31+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
3032
# options for the plugin
3133
options:
3234
# the repo's owner. It should be case-sensitive here; strictly use your GitHub user name; please change the value below.

docs/plugins/gitlabci-generic.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ tools:
2121
- name: myapp-ci
2222
# name of the plugin
2323
plugin: gitlabci-generic
24+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
25+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
26+
# options for the plugin
2427
options:
2528
# owner/repo; "path with namespace" is only GitLab API's way of saying the same thing; please change the values below.
2629
pathWithNamespace: YOUR_GITLAB_USERNAME/YOUR_GITLAB_REPO_NAME

docs/plugins/gitlabci-golang.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ tools:
1919
- name: go-hello-world
2020
# name of the plugin
2121
plugin: gitlabci-golang
22+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
23+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
2224
# options for the plugin
2325
options:
2426
# owner/repo; "path with namespace" is only GitLab API's way of saying the same thing; please change the values below.

docs/plugins/jenkins.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ tools:
1919
- name: jenkins-dev
2020
# name of the plugin
2121
plugin: jenkins
22+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
23+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
2224
# options for the plugin
2325
options:
2426
# need to create the namespace or not, default: false

docs/plugins/jira-github-integ.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ tools:
2525
- name: default
2626
# name of the plugin
2727
plugin: jira-github-integ
28+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
29+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
2830
# options for the plugin
2931
options:
3032
# the repo's owner

docs/plugins/kube-prometheus.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ tools:
1010
- name: kube-prometheus-dev
1111
# name of the plugin
1212
plugin: kube-prometheus
13+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
14+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
1315
# options for the plugin
1416
options:
1517
# need to create the namespace or not, default: false

docs/plugins/openldap.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,9 @@ tools:
99
- name: openldap
1010
# name of the plugin
1111
plugin: openldap
12+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
13+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
14+
# options for the plugin
1215
options:
1316
# need to create the namespace or not, default: false
1417
create_namespace: true

docs/plugins/trello-github-integ.md

Lines changed: 35 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -10,34 +10,41 @@ This plugin depends on and can be used together with the `trello` plugin (see do
1010

1111
```yaml
1212
tools:
13-
- name: my-trello-board
14-
# name of the plugin
15-
plugin: trello
16-
dependsOn: ["demo.github-repo-scaffolding-golang"]
17-
options:
18-
owner: YOUR_GITHUB_USERNAME
19-
repo: YOUR_REPO_NAME
20-
kanbanBoardName: KANBAN_BOARD_NAME
21-
- name: trello-github
22-
# name of the plugin
23-
plugin: trello-github-integ
24-
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
25-
dependsOn: [ "my-trello-board.trello" ]
26-
# options for the plugin
27-
options:
28-
# the repo's owner. It should be case-sensitive here; strictly use your GitHub user name; please change the value below.
29-
owner: YOUR_GITHUB_USERNAME
30-
# the repo's org. If you set this property, then the new repo will be created under the org you're given, and the "owner" setting above will be ignored.
31-
org: YOUR_ORGANIZATION_NAME
32-
# the repo where you'd like to setup GitHub Actions; please change the value below.
33-
repo: YOUR_REPO_NAME
34-
# reference parameters come from dependency, their usage will be explained later
35-
boardId: ${{ my-trello-board.trello.outputs.boardId }}
36-
todoListId: ${{ my-trello-board.trello.outputs.todoListId }}
37-
doingListId: ${{ my-trello-board.trello.outputs.doingListId }}
38-
doneListId: ${{ my-trello-board.trello.outputs.doneListId }}
39-
# main branch of the repo (to which branch the plugin will submit the workflows)
40-
branch: main
13+
- name: my-trello-board
14+
# name of the plugin
15+
plugin: trello
16+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool
17+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
18+
# options for the plugin
19+
options:
20+
# the repo's owner
21+
owner: YOUR_GITHUB_USERNAME
22+
# the repo's org. If you set this property, then the new repo will be created under the org you're given, and the "owner" setting above will be ignored.
23+
org: YOUR_ORGANIZATION_NAME
24+
# for which repo this board will be used
25+
repo: YOUR_REPO_NAME
26+
# the Tello board name. If empty, use owner/repo as the board's name.
27+
kanbanBoardName: KANBAN_BOARD_NAME
28+
- name: trello-github
29+
# name of the plugin
30+
plugin: trello-github-integ
31+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
32+
dependsOn: [ "TRELLO_TOOL_NAME.trello" ]
33+
# options for the plugin
34+
options:
35+
# the repo's owner. It should be case-sensitive here; strictly use your GitHub user name; please change the value below.
36+
owner: YOUR_GITHUB_USERNAME
37+
# the repo where you'd like to setup GitHub Actions; please change the value below.
38+
# the repo's org. If you set this property, then the new repo will be created under the org you're given, and the "owner" setting above will be ignored.
39+
org: YOUR_ORGANIZATION_NAME
40+
repo: YOUR_REPO_NAME
41+
# reference parameters come from dependency, their usage will be explained later
42+
boardId: ${{ TRELLO_TOOL_NAME.trello.outputs.boardId }}
43+
todoListId: ${{ TRELLO_TOOL_NAME.trello.outputs.todoListId }}
44+
doingListId: ${{ TRELLO_TOOL_NAME.trello.outputs.doingListId }}
45+
doneListId: ${{ TRELLO_TOOL_NAME.trello.outputs.doneListId }}
46+
# main branch of the repo (to which branch the plugin will submit the workflows)
47+
branch: main
4148
```
4249
4350
Replace the following from the config above:

docs/plugins/trello.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,9 @@ tools:
2121
- name: my-trello-board
2222
# name of the plugin
2323
plugin: trello
24-
# options for the plugin, checkout the version from the GitHub releases
24+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool
25+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
26+
# options for the plugin
2527
options:
2628
# the repo's owner
2729
owner: YOUR_GITHUB_USERNAME

internal/pkg/show/config/plugin/argocd.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ var ArgocdDefaultConfig = `tools:
44
- name: argocd
55
# name of the plugin
66
plugin: argocd
7+
# if specified, dtm will make sure the dependency is applied first before handling this tool.
8+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
9+
# options for the plugin
710
options:
811
# need to create the namespace or not, default: false
912
create_namespace: true

internal/pkg/show/config/plugin/devlake.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@ package plugin
33
var DevlakeDefaultConfig = `tools:
44
- name: devlake
55
# name of the plugin
6-
plugin: devlake`
6+
plugin: devlake
7+
# if specified, dtm will make sure the dependency is applied first before handling this tool.
8+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]`

internal/pkg/show/config/plugin/github-repo-scaffolding-golang.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ var GithubRepoScaffoldingGolangDefaultConfig = `tools:
55
- name: go-webapp-repo
66
# name of the plugin
77
plugin: github-repo-scaffolding-golang
8+
# if specified, dtm will make sure the dependency is applied first before handling this tool.
9+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
810
# options for the plugin
911
options:
1012
# the repo's owner. It should be case-sensitive here; strictly use your GitHub user name; please change the value below.

internal/pkg/show/config/plugin/gitlabci-generic.go

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ var GitlabCIGenericDefaultConfig = `tools:
44
- name: myapp-ci
55
# name of the plugin
66
plugin: gitlabci-generic
7+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
8+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
9+
# options for the plugin
710
options:
811
# owner/repo; "path with namespace" is only GitLab API's way of saying the same thing; please change the values below.
912
pathWithNamespace: YOUR_GITLAB_USERNAME/YOUR_GITLAB_REPO_NAME

internal/pkg/show/config/plugin/gitlabci-golang.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ var GitlabCIGolangDefaultConfig = `tools:
44
- name: go-hello-world
55
# name of the plugin
66
plugin: gitlabci-golang
7+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
8+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
79
# options for the plugin
810
options:
911
# owner/repo; "path with namespace" is only GitLab API's way of saying the same thing; please change the values below.

internal/pkg/show/config/plugin/jenkins.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ var JenkinsDefaultConfig = `tools:
55
- name: jenkins-dev
66
# name of the plugin
77
plugin: jenkins
8+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
9+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
810
# options for the plugin
911
options:
1012
# need to create the namespace or not, default: false

internal/pkg/show/config/plugin/jira-github-integ.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ var JiraGithubDefaultConfig = `tools:
44
- name: default
55
# name of the plugin
66
plugin: jira-github-integ
7+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
8+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
79
# options for the plugin
810
options:
911
# the repo's owner

internal/pkg/show/config/plugin/kube-prometheus.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ var KubePrometheusDefaultConfig = `tools:
55
- name: kube-prometheus-dev
66
# name of the plugin
77
plugin: kube-prometheus
8+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
9+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
810
# options for the plugin
911
options:
1012
# need to create the namespace or not, default: false

internal/pkg/show/config/plugin/openldap.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ var OpenldapDefaultConfig = `tools:
44
- name: openldap
55
# name of the plugin
66
plugin: openldap
7+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
8+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
9+
# options for the plugin
710
options:
811
# need to create the namespace or not, default: false
912
create_namespace: true
@@ -31,7 +34,7 @@ var OpenldapDefaultConfig = `tools:
3134
type: NodePort
3235
env:
3336
LDAP_ORGANISATION: "DevStream Inc."
34-
LDAP_DOMAIN: "devstream.org"
37+
LDAP_DOMAIN: "devstream.io"
3538
persistence:
3639
enabled: false
3740
adminPassword: Not@SecurePassw0rd
Lines changed: 5 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,11 @@
11
package plugin
22

33
var TrelloGithubDefaultConfig = `tools:
4-
- name: my-trello-board
5-
# name of the plugin
6-
plugin: trello
7-
dependsOn: ["demo.github-repo-scaffolding-golang"]
8-
options:
9-
owner: YOUR_GITHUB_USERNAME
10-
repo: YOUR_REPO_NAME
11-
kanbanBoardName: KANBAN_BOARD_NAME
124
- name: trello-github
135
# name of the plugin
146
plugin: trello-github-integ
157
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
16-
dependsOn: [ "my-trello-board.trello" ]
8+
dependsOn: [ "TRELLO_TOOL_NAME.trello" ]
179
# options for the plugin
1810
options:
1911
# the repo's owner. It should be case-sensitive here; strictly use your GitHub user name; please change the value below.
@@ -23,9 +15,9 @@ var TrelloGithubDefaultConfig = `tools:
2315
org: YOUR_ORGANIZATION_NAME
2416
repo: YOUR_REPO_NAME
2517
# reference parameters come from dependency, their usage will be explained later
26-
boardId: ${{ my-trello-board.trello.outputs.boardId }}
27-
todoListId: ${{ my-trello-board.trello.outputs.todoListId }}
28-
doingListId: ${{ my-trello-board.trello.outputs.doingListId }}
29-
doneListId: ${{ my-trello-board.trello.outputs.doneListId }}
18+
boardId: ${{ TRELLO_TOOL_NAME.trello.outputs.boardId }}
19+
todoListId: ${{ TRELLO_TOOL_NAME.trello.outputs.todoListId }}
20+
doingListId: ${{ TRELLO_TOOL_NAME.trello.outputs.doingListId }}
21+
doneListId: ${{ TRELLO_TOOL_NAME.trello.outputs.doneListId }}
3022
# main branch of the repo (to which branch the plugin will submit the workflows)
3123
branch: main`

internal/pkg/show/config/plugin/trello.go

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ var TrelloDefaultConfig = `tools:
44
- name: my-trello-board
55
# name of the plugin
66
plugin: trello
7-
# options for the plugin, checkout the version from the GitHub releases
7+
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool
8+
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
9+
# options for the plugin
810
options:
911
# the repo's owner
1012
owner: YOUR_GITHUB_USERNAME

0 commit comments

Comments
 (0)