fix: gitops and quickstart error

steinliber · steinliber · commit 626c43453b4a · 2022-12-15T14:35:08.000+08:00
Signed-off-by: Meng JiaFeng &lt;jiafeng.meng@merico.dev&gt;
diff --git a/docs/best-practices/gitops.md b/docs/best-practices/gitops.md
@@ -119,65 +119,10 @@ Use "dtm [command] --help" for more information about a command.
 
 ## 4 Config File
 
-Create a file named `config.yaml` and paste the following content into it:
-
-```yaml
-config:
-  state:
-    backend: local
-    options:
-      stateFile: devstream.state
-vars:
-  githubUser: IronCore864
-  dockerUser: ironcore864
-  app: helloworld
-
-tools:
-- name: repo-scaffolding
-  instanceID: myapp
-  options:
-    destinationRepo:
-      owner: [[ githubUser ]]
-      name: [[ app ]]
-      branch: main
-      scmType: github
-    sourceRepo:
-      org: devstream-io
-      name: dtm-scaffolding-flask
-      scmType: github
-- name: github-actions
-  instanceID: flask
-  dependsOn: [ repo-scaffolding.myapp ]
-  options:
-    scm:
-      owner: [[ githubUser ]]
-      name:  [[ app ]]
-      scmType: github
-    pipeline:
-      configLocation: https://raw.githubusercontent.com/devstream-io/ci-template/main/github-actions/workflows/main.yml
-      language:
-        name: python
-        framework: flask
-      imageRepo:
-        user: [[ dockerUser ]]
-- name: helm-installer
-  instanceID: argocd
-- name: argocdapp
-  instanceID: default
-  dependsOn: [ "helm-installer.argocd", "github-actions.flask" ]
-  options:
-    app:
-      name: [[ app ]]
-      namespace: argocd
-    destination:
-      server: https://kubernetes.default.svc
-      namespace: default
-    source:
-      valuefile: values.yaml
-      path: helm/[[ app ]]
-      repoURL: ${{repo-scaffolding.myapp.outputs.repoURL}}
-    imageRepo:
-      user: [[ dockerUser ]]
+Run command below to get a valid `config.yaml` file:
+
+```shell
+./dtm show config -t gitops > config.yaml
 ```
 
 Then modify the `vars` section in the `config.yaml` file accordingly. Please update the values for `githubUser` and `dockerUser` to your real users.
diff --git a/docs/best-practices/gitops.zh.md b/docs/best-practices/gitops.zh.md
@@ -119,65 +119,10 @@ Use "dtm [command] --help" for more information about a command.
 
 ## 4 配置文件
 
-创建一个名为 `config.yaml` 的文件，并把下面的内容粘贴进去：
-
-```yaml
-config:
-  state:
-    backend: local
-    options:
-      stateFile: devstream.state
-vars:
-  githubUser: IronCore864
-  dockerUser: ironcore864
-  app: helloworld
-
-tools:
-- name: repo-scaffolding
-  instanceID: myapp
-  options:
-    destinationRepo:
-      owner: [[ githubUser ]]
-      name: [[ app ]]
-      branch: main
-      scmType: github
-    sourceRepo:
-      org: devstream-io
-      name: dtm-scaffolding-flask
-      scmType: github
-- name: github-actions
-  instanceID: flask
-  dependsOn: [ repo-scaffolding.myapp ]
-  options:
-    scm:
-      owner: [[ githubUser ]]
-      name:  [[ app ]]
-      scmType: github
-    pipeline:
-      configLocation: https://raw.githubusercontent.com/devstream-io/ci-template/main/github-actions/workflows/main.yml
-      language:
-        name: python
-        framework: flask
-      imageRepo:
-        user: [[ dockerUser ]]
-- name: helm-installer
-  instanceID: argocd
-- name: argocdapp
-  instanceID: default
-  dependsOn: [ "helm-installer.argocd", "github-actions.flask" ]
-  options:
-    app:
-      name: [[ app ]]
-      namespace: argocd
-    destination:
-      server: https://kubernetes.default.svc
-      namespace: default
-    source:
-      valuefile: values.yaml
-      path: helm/[[ app ]]
-      repoURL: ${{repo-scaffolding.myapp.outputs.repoURL}}
-    imageRepo:
-      user: [[ dockerUser ]]
+运行以下命令来生成 gitops 的模板配置文件 `config.yaml` 。
+
+```shell
+./dtm show config -t gitops > config.yaml
 ```
 
 按需修改 `config.yaml` 文件中的 `vars` 部分。记得修改 `githubUser` 和 `dockerUser` 的值为你自己的用户名。
diff --git a/examples/gitops.yaml b/examples/gitops.yaml
@@ -1,73 +1,56 @@
 config:
-  state: # state config, backend can be local, s3 or k8s
+  state:
     backend: local
     options:
       stateFile: devstream.state
-
 vars:
-  defaultBranch: main
-  githubUsername: daniel-hutao
-  repoName: dtm-test-go
-  jiraID: merico
-  jiraUserEmail: tao.hu@merico.dev
-  jiraProjectKey: DT
-  dockerhubUsername: exploitht
-  argocdNameSpace: argocd
+  githubUser: GITHUB_USER
+  dockerUser: DOCKERHUB_USER
+  app: helloworld
 
 tools:
 - name: repo-scaffolding
-  instanceID: golang-github
+  instanceID: myapp
   options:
     destinationRepo:
-      owner: [[ githubUsername ]]
-      name: [[ repoName ]]
-      branch: [[ defaultBranch ]]
+      owner: [[ githubUser ]]
+      name: [[ app ]]
+      branch: main
       scmType: github
     sourceRepo:
       org: devstream-io
-      name: dtm-scaffolding-golang
+      name: dtm-repo-scaffolding-python-flask
       scmType: github
-    vars:
-      imageRepo: "[[ dockerhubUsername ]]/[[ repoName ]]"
-- name: jira-github-integ
-  instanceID: default
-  dependsOn: [ "repo-scaffolding.golang-github" ]
-  options:
-    owner: [[ githubUsername ]]
-    repo: [[ repoName ]]
-    jiraBaseUrl: https://[[ jiraID ]].atlassian.net
-    jiraUserEmail: [[ jiraUserEmail ]]
-    jiraProjectKey: [[ jiraProjectKey ]]
-    branch: main
 - name: github-actions
-  instanceID: default
-  dependsOn: [ "repo-scaffolding.golang-github" ]
+  instanceID: flask
+  dependsOn: [ repo-scaffolding.myapp ]
   options:
     scm:
-      owner: ${{repo-scaffolding.golang-github.outputs.owner}}
-      name: ${{repo-scaffolding.golang-github.outputs.repo}}
-      branch: [[ defaultBranch ]]
+      owner: [[ githubUser ]]
+      name:  [[ app ]]
       scmType: github
     pipeline:
-      configLocation: https://raw.githubusercontent.com/devstream-io/ci-template/main/github-actions/workflows/main.yml
+      configLocation: https://raw.githubusercontent.com/devstream-io/dtm-pipeline-templates/main/github-actions/workflows/main.yml
       language:
-        name: go
-        framework: gin
+        name: python
+        framework: flask
       imageRepo:
-        user: [[ dockerhubUsername ]]
+        user: [[ dockerUser ]]
 - name: helm-installer
   instanceID: argocd
 - name: argocdapp
   instanceID: default
-  dependsOn: ["helm-installer.argocd", "repo-scaffolding.golang-github"]
+  dependsOn: [ "helm-installer.argocd", "github-actions.flask" ]
   options:
     app:
-      name: ${{repo-scaffolding.golang-github.outputs.repo}}
-      namespace: [[ argocdNameSpace ]]
+      name: [[ app ]]
+      namespace: argocd
     destination:
       server: https://kubernetes.default.svc
       namespace: default
     source:
       valuefile: values.yaml
-      path: helm/${{repo-scaffolding.golang-github.outputs.repo}}
-      repoURL: ${{repo-scaffolding.golang-github.outputs.repoURL}}
+      path: helm/[[ app ]]
+      repoURL: ${{repo-scaffolding.myapp.outputs.repoURL}}
+    imageRepo:
+      user: [[ dockerUser ]]
diff --git a/examples/quickstart.yaml b/examples/quickstart.yaml
@@ -19,7 +19,7 @@ tools:
       scmType: github
     sourceRepo:
       org: devstream-io
-      name: dtm-scaffolding-gin
+      name: dtm-repo-scaffolding-golang-gin
       scmType: github
 - name: github-actions
   instanceID: default
diff --git a/internal/pkg/plugin/githubactions/validate.go b/internal/pkg/plugin/githubactions/validate.go
@@ -19,8 +19,8 @@ func validate(options configmanager.RawOptions) (configmanager.RawOptions, error
 		return nil, err
 	}
 	// check repo is valid
-	if opts.ProjectRepo.RepoType != "github" {
-		return nil, fmt.Errorf("github action don't support other repo")
+	if !opts.ProjectRepo.IsGithubRepo() {
+		return nil, fmt.Errorf("github action only support other repo")
 	}
 	return options, nil
 }
diff --git a/internal/pkg/show/config/templates/gitops.yaml b/internal/pkg/show/config/templates/gitops.yaml
@@ -1,73 +1,56 @@
 config:
-  state: # state config, backend can be local, s3 or k8s
+  state:
     backend: local
     options:
       stateFile: devstream.state
-
 vars:
-  defaultBranch: main
-  githubUsername: daniel-hutao
-  repoName: dtm-test-go
-  jiraID: merico
-  jiraUserEmail: tao.hu@merico.dev
-  jiraProjectKey: DT
-  dockerhubUsername: exploitht
-  argocdNameSpace: argocd
+  githubUser: GITHUB_USER
+  dockerUser: DOCKERHUB_USER
+  app: helloworld
 
 tools:
 - name: repo-scaffolding
-  instanceID: golang-github
+  instanceID: myapp
   options:
     destinationRepo:
-      owner: [[ githubUsername ]]
-      name: [[ repoName ]]
-      branch: [[ defaultBranch ]]
+      owner: [[ githubUser ]]
+      name: [[ app ]]
+      branch: main
       scmType: github
     sourceRepo:
       org: devstream-io
-      name: dtm-scaffolding-golang
+      name: dtm-repo-scaffolding-python-flask
       scmType: github
-    vars:
-      imageRepo: "[[ dockerhubUsername ]]/[[ repoName ]]"
-- name: jira-github-integ
-  instanceID: default
-  dependsOn: [ "repo-scaffolding.golang-github" ]
-  options:
-    owner: [[ githubUsername ]]
-    repo: [[ repoName ]]
-    jiraBaseUrl: https://[[ jiraID ]].atlassian.net
-    jiraUserEmail: [[ jiraUserEmail ]]
-    jiraProjectKey: [[ jiraProjectKey ]]
-    branch: main
 - name: github-actions
-  instanceID: default
-  dependsOn: [ "repo-scaffolding.golang-github" ]
+  instanceID: flask
+  dependsOn: [ repo-scaffolding.myapp ]
   options:
     scm:
-      owner: ${{repo-scaffolding.golang-github.outputs.owner}}
-      name: ${{repo-scaffolding.golang-github.outputs.repo}}
-      branch: [[ defaultBranch ]]
+      owner: [[ githubUser ]]
+      name:  [[ app ]]
       scmType: github
     pipeline:
-      configLocation: https://raw.githubusercontent.com/devstream-io/ci-template/main/github-actions/workflows/main.yml
+      configLocation: https://raw.githubusercontent.com/devstream-io/dtm-pipeline-templates/main/github-actions/workflows/main.yml
       language:
-        name: go
-        framework: gin
+        name: python
+        framework: flask
       imageRepo:
-        user: [[ dockerhubUsername ]]
+        user: [[ dockerUser ]]
 - name: helm-installer
   instanceID: argocd
 - name: argocdapp
   instanceID: default
-  dependsOn: ["helm-installer.argocd", "repo-scaffolding.golang-github"]
+  dependsOn: [ "helm-installer.argocd", "github-actions.flask" ]
   options:
     app:
-      name: ${{repo-scaffolding.golang-github.outputs.repo}}
-      namespace: [[ argocdNameSpace ]]
+      name: [[ app ]]
+      namespace: argocd
     destination:
       server: https://kubernetes.default.svc
       namespace: default
     source:
       valuefile: values.yaml
-      path: helm/${{repo-scaffolding.golang-github.outputs.repo}}
-      repoURL: ${{repo-scaffolding.golang-github.outputs.repoURL}}
+      path: helm/[[ app ]]
+      repoURL: ${{repo-scaffolding.myapp.outputs.repoURL}}
+    imageRepo:
+      user: [[ dockerUser ]]
diff --git a/internal/pkg/show/config/templates/quickstart.yaml b/internal/pkg/show/config/templates/quickstart.yaml
@@ -19,7 +19,7 @@ tools:
       scmType: github
     sourceRepo:
       org: devstream-io
-      name: dtm-scaffolding-gin
+      name: dtm-repo-scaffolding-golang-gin
       scmType: github
 - name: github-actions
   instanceID: default
diff --git a/pkg/util/scm/git/repoinfo.go b/pkg/util/scm/git/repoinfo.go

Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@ func validate(options configmanager.RawOptions) (configmanager.RawOptions, error`
`19`	`19`	`return nil, err`
`20`	`20`	`}`
`21`	`21`	`// check repo is valid`
`22`		`- if opts.ProjectRepo.RepoType != "github" {`
`23`		`- return nil, fmt.Errorf("github action don't support other repo")`
	`22`	`+ if !opts.ProjectRepo.IsGithubRepo() {`
	`23`	`+ return nil, fmt.Errorf("github action only support other repo")`
`24`	`24`	`}`
`25`	`25`	`return options, nil`
`26`	`26`	`}`