Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: adding the missing config field for most plugins. #416

Merged
merged 2 commits into from
Apr 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/plugins/argocd.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ tools:
- name: argocd
# name of the plugin
plugin: argocd
# if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# need to create the namespace or not, default: false
create_namespace: true
Expand Down
2 changes: 2 additions & 0 deletions docs/plugins/devlake.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ tools:
- name: devlake
# name of the plugin
plugin: devlake
# if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
```

All the parameters in the example above are mandatory.
2 changes: 2 additions & 0 deletions docs/plugins/github-repo-scaffolding-golang.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@ tools:
- name: go-webapp-repo
# name of the plugin
plugin: github-repo-scaffolding-golang
# if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# the repo's owner. It should be case-sensitive here; strictly use your GitHub user name; please change the value below.
Expand Down
3 changes: 3 additions & 0 deletions docs/plugins/gitlabci-generic.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,9 @@ tools:
- name: myapp-ci
# name of the plugin
plugin: gitlabci-generic
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# owner/repo; "path with namespace" is only GitLab API's way of saying the same thing; please change the values below.
pathWithNamespace: YOUR_GITLAB_USERNAME/YOUR_GITLAB_REPO_NAME
Expand Down
2 changes: 2 additions & 0 deletions docs/plugins/gitlabci-golang.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ tools:
- name: go-hello-world
# name of the plugin
plugin: gitlabci-golang
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# owner/repo; "path with namespace" is only GitLab API's way of saying the same thing; please change the values below.
Expand Down
2 changes: 2 additions & 0 deletions docs/plugins/jenkins.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ tools:
- name: jenkins-dev
# name of the plugin
plugin: jenkins
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# need to create the namespace or not, default: false
Expand Down
2 changes: 2 additions & 0 deletions docs/plugins/jira-github-integ.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ tools:
- name: default
# name of the plugin
plugin: jira-github-integ
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# the repo's owner
Expand Down
2 changes: 2 additions & 0 deletions docs/plugins/kube-prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ tools:
- name: kube-prometheus-dev
# name of the plugin
plugin: kube-prometheus
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# need to create the namespace or not, default: false
Expand Down
3 changes: 3 additions & 0 deletions docs/plugins/openldap.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ tools:
- name: openldap
# name of the plugin
plugin: openldap
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# need to create the namespace or not, default: false
create_namespace: true
Expand Down
63 changes: 35 additions & 28 deletions docs/plugins/trello-github-integ.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,34 +10,41 @@ This plugin depends on and can be used together with the `trello` plugin (see do

```yaml
tools:
- name: my-trello-board
# name of the plugin
plugin: trello
dependsOn: ["demo.github-repo-scaffolding-golang"]
options:
owner: YOUR_GITHUB_USERNAME
repo: YOUR_REPO_NAME
kanbanBoardName: KANBAN_BOARD_NAME
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I think it's better to keep trello plugin config, since trello-github-integ depends on its outputs.

- name: trello-github
# name of the plugin
plugin: trello-github-integ
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "my-trello-board.trello" ]
# options for the plugin
options:
# the repo's owner. It should be case-sensitive here; strictly use your GitHub user name; please change the value below.
owner: YOUR_GITHUB_USERNAME
# 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.
org: YOUR_ORGANIZATION_NAME
# the repo where you'd like to setup GitHub Actions; please change the value below.
repo: YOUR_REPO_NAME
# reference parameters come from dependency, their usage will be explained later
boardId: ${{ my-trello-board.trello.outputs.boardId }}
todoListId: ${{ my-trello-board.trello.outputs.todoListId }}
doingListId: ${{ my-trello-board.trello.outputs.doingListId }}
doneListId: ${{ my-trello-board.trello.outputs.doneListId }}
# main branch of the repo (to which branch the plugin will submit the workflows)
branch: main
- name: my-trello-board
# name of the plugin
plugin: trello
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# the repo's owner
owner: YOUR_GITHUB_USERNAME
# 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.
org: YOUR_ORGANIZATION_NAME
# for which repo this board will be used
repo: YOUR_REPO_NAME
# the Tello board name. If empty, use owner/repo as the board's name.
kanbanBoardName: KANBAN_BOARD_NAME
- name: trello-github
# name of the plugin
plugin: trello-github-integ
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TRELLO_TOOL_NAME.trello" ]
# options for the plugin
options:
# the repo's owner. It should be case-sensitive here; strictly use your GitHub user name; please change the value below.
owner: YOUR_GITHUB_USERNAME
# the repo where you'd like to setup GitHub Actions; please change the value below.
# 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.
org: YOUR_ORGANIZATION_NAME
repo: YOUR_REPO_NAME
# reference parameters come from dependency, their usage will be explained later
boardId: ${{ TRELLO_TOOL_NAME.trello.outputs.boardId }}
todoListId: ${{ TRELLO_TOOL_NAME.trello.outputs.todoListId }}
doingListId: ${{ TRELLO_TOOL_NAME.trello.outputs.doingListId }}
doneListId: ${{ TRELLO_TOOL_NAME.trello.outputs.doneListId }}
# main branch of the repo (to which branch the plugin will submit the workflows)
branch: main
```

Replace the following from the config above:
Expand Down
4 changes: 3 additions & 1 deletion docs/plugins/trello.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ tools:
- name: my-trello-board
# name of the plugin
plugin: trello
# options for the plugin, checkout the version from the GitHub releases
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# the repo's owner
owner: YOUR_GITHUB_USERNAME
Expand Down
3 changes: 3 additions & 0 deletions internal/pkg/show/config/plugin/argocd.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ var ArgocdDefaultConfig = `tools:
- name: argocd
# name of the plugin
plugin: argocd
# if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# need to create the namespace or not, default: false
create_namespace: true
Expand Down
4 changes: 3 additions & 1 deletion internal/pkg/show/config/plugin/devlake.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,6 @@ package plugin
var DevlakeDefaultConfig = `tools:
- name: devlake
# name of the plugin
plugin: devlake`
plugin: devlake
# if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]`
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ var GithubRepoScaffoldingGolangDefaultConfig = `tools:
- name: go-webapp-repo
# name of the plugin
plugin: github-repo-scaffolding-golang
# if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# the repo's owner. It should be case-sensitive here; strictly use your GitHub user name; please change the value below.
Expand Down
3 changes: 3 additions & 0 deletions internal/pkg/show/config/plugin/gitlabci-generic.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ var GitlabCIGenericDefaultConfig = `tools:
- name: myapp-ci
# name of the plugin
plugin: gitlabci-generic
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# owner/repo; "path with namespace" is only GitLab API's way of saying the same thing; please change the values below.
pathWithNamespace: YOUR_GITLAB_USERNAME/YOUR_GITLAB_REPO_NAME
Expand Down
2 changes: 2 additions & 0 deletions internal/pkg/show/config/plugin/gitlabci-golang.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ var GitlabCIGolangDefaultConfig = `tools:
- name: go-hello-world
# name of the plugin
plugin: gitlabci-golang
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# owner/repo; "path with namespace" is only GitLab API's way of saying the same thing; please change the values below.
Expand Down
2 changes: 2 additions & 0 deletions internal/pkg/show/config/plugin/jenkins.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ var JenkinsDefaultConfig = `tools:
- name: jenkins-dev
# name of the plugin
plugin: jenkins
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# need to create the namespace or not, default: false
Expand Down
2 changes: 2 additions & 0 deletions internal/pkg/show/config/plugin/jira-github-integ.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ var JiraGithubDefaultConfig = `tools:
- name: default
# name of the plugin
plugin: jira-github-integ
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# the repo's owner
Expand Down
2 changes: 2 additions & 0 deletions internal/pkg/show/config/plugin/kube-prometheus.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ var KubePrometheusDefaultConfig = `tools:
- name: kube-prometheus-dev
# name of the plugin
plugin: kube-prometheus
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# need to create the namespace or not, default: false
Expand Down
5 changes: 4 additions & 1 deletion internal/pkg/show/config/plugin/openldap.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@ var OpenldapDefaultConfig = `tools:
- name: openldap
# name of the plugin
plugin: openldap
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# need to create the namespace or not, default: false
create_namespace: true
Expand Down Expand Up @@ -31,7 +34,7 @@ var OpenldapDefaultConfig = `tools:
type: NodePort
env:
LDAP_ORGANISATION: "DevStream Inc."
LDAP_DOMAIN: "devstream.org"
LDAP_DOMAIN: "devstream.io"
persistence:
enabled: false
adminPassword: Not@SecurePassw0rd
Expand Down
18 changes: 5 additions & 13 deletions internal/pkg/show/config/plugin/trello-github-integ.go
Original file line number Diff line number Diff line change
@@ -1,19 +1,11 @@
package plugin

var TrelloGithubDefaultConfig = `tools:
- name: my-trello-board
# name of the plugin
plugin: trello
dependsOn: ["demo.github-repo-scaffolding-golang"]
options:
owner: YOUR_GITHUB_USERNAME
repo: YOUR_REPO_NAME
kanbanBoardName: KANBAN_BOARD_NAME
- name: trello-github
# name of the plugin
plugin: trello-github-integ
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
dependsOn: [ "my-trello-board.trello" ]
dependsOn: [ "TRELLO_TOOL_NAME.trello" ]
# options for the plugin
options:
# the repo's owner. It should be case-sensitive here; strictly use your GitHub user name; please change the value below.
Expand All @@ -23,9 +15,9 @@ var TrelloGithubDefaultConfig = `tools:
org: YOUR_ORGANIZATION_NAME
repo: YOUR_REPO_NAME
# reference parameters come from dependency, their usage will be explained later
boardId: ${{ my-trello-board.trello.outputs.boardId }}
todoListId: ${{ my-trello-board.trello.outputs.todoListId }}
doingListId: ${{ my-trello-board.trello.outputs.doingListId }}
doneListId: ${{ my-trello-board.trello.outputs.doneListId }}
boardId: ${{ TRELLO_TOOL_NAME.trello.outputs.boardId }}
todoListId: ${{ TRELLO_TOOL_NAME.trello.outputs.todoListId }}
doingListId: ${{ TRELLO_TOOL_NAME.trello.outputs.doingListId }}
doneListId: ${{ TRELLO_TOOL_NAME.trello.outputs.doneListId }}
# main branch of the repo (to which branch the plugin will submit the workflows)
branch: main`
4 changes: 3 additions & 1 deletion internal/pkg/show/config/plugin/trello.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@ var TrelloDefaultConfig = `tools:
- name: my-trello-board
# name of the plugin
plugin: trello
# options for the plugin, checkout the version from the GitHub releases
# optional; if specified, dtm will make sure the dependency is applied first before handling this tool
dependsOn: [ "TOOL1_NAME.TOOL1_PLUGIN", "TOOL2_NAME.TOOL2_PLUGIN" ]
# options for the plugin
options:
# the repo's owner
owner: YOUR_GITHUB_USERNAME
Expand Down