Merge pull request #1359 from devstream-io/main

Prepare to release v0.10.3

Author: daniel-hutao

.github/sync-staging-repo.yml

@@ -0,0 +1,24 @@
+devstream-io/dtm-gitlab-share-library:
+  - source: staging/dtm-gitlab-share-library/
+    dest: .
+    deleteOrphaned: true
+devstream-io/dtm-pipeline-templates:
+  - source: staging/dtm-pipeline-templates/
+    dest: .
+    deleteOrphaned: true
+devstream-io/dtm-repo-scaffolding-golang-cli:
+  - source: staging/dtm-repo-scaffolding-golang-cli/
+    dest: .
+    deleteOrphaned: true
+devstream-io/dtm-repo-scaffolding-golang-gin:
+  - source: staging/dtm-repo-scaffolding-golang-gin/
+    dest: .
+    deleteOrphaned: true
+devstream-io/dtm-repo-scaffolding-java-springboot:
+  - source: staging/dtm-repo-scaffolding-java-springboot/
+    dest: .
+    deleteOrphaned: true
+devstream-io/dtm-repo-scaffolding-python-flask:
+  - source: staging/dtm-repo-scaffolding-python-flask/
+    dest: .
+    deleteOrphaned: true

.github/workflows/sync-staging-repo.yml

@@ -0,0 +1,24 @@
+name: Sync Staging Files to Other Repos
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - staging/**
+      - .github/workflows/sync-staging-repo.yml
+      - .github/sync-staging-repo.yml
+  workflow_dispatch:
+
+jobs:
+  sync:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Run GitHub File Sync
+        uses: BetaHuhn/[email protected]
+        with:
+          GH_PAT: ${{ secrets.GH_PAT }}
+          CONFIG_PATH: .github/sync-staging-repo.yml
+          ORIGINAL_MESSAGE: true
+          SKIP_PR: true
+          COMMIT_EACH_FILE: false

.gitignore

@@ -27,7 +27,6 @@ docs/build
 
 # YAML for testings
 config*.yaml*
-app*.yaml
 variables*.yaml
 variables*.yaml.bak
 tools*.yaml
@@ -53,5 +52,8 @@ testbin/
 # terraform
 .terraform
 
+# test
+cov
+
 # md
 README_when_create_plugin.md

.lycheeignore

@@ -8,6 +8,7 @@ https://fonts.gstatic.com/
 .*xxx.*
 .*changeme.*
 .*example.*
+.*test.*
 .*YOUR_.*
 https://id.atlassian.net
 https://JIRA_ID.atlassian.net

.yamllint.yml

@@ -32,3 +32,4 @@ ignore: |
   **/.github/**
   **/githubactions/**
   **/workflows/**
+  **/staging/**

README.md

@@ -91,7 +91,7 @@ I am happy to tell you that we have, and we are constantly adding more possible
 so you are more than welcome to tell us what combinations you expect.
 
 - [GitOps Toolchain](https://docs.devstream.io/en/latest/best-practices/gitops/)
-- [GitLab, Jenkins and Harbor On Premise Toolchain (Chinese only for now)](https://docs.devstream.io/en/latest/best-practices/gitlab-jenkins-harbor.zh/)
+- [GitLab, Jenkins and Harbor On Premise Toolchain (Chinese only for now)](https://docs.devstream.io/en/latest/best-practices/gitlab-jenkins-harbor-java-springboot.zh/)
 
 ## Supported DevOps Tools
 

README_zh.md

@@ -92,7 +92,7 @@ DevStream支持许多工具的管理。你可以灵活地结合一些工具来
 我们非常欢迎你告诉我们你期望的组合。
 
 - [GitOps工具链](https://docs.devstream.io/en/latest/best-practices/gitops.zh/)
-- [用 DevStream 搭建 GitLab + Jenkins + Harbor 工具链，管理 Java Spring Boot 项目开发生命周期全流程](https://docs.devstream.io/en/latest/best-practices/gitlab-jenkins-harbor.zh/)
+- [用 DevStream 搭建 GitLab + Jenkins + Harbor 工具链，管理 Java Spring Boot 项目开发生命周期全流程](https://docs.devstream.io/en/latest/best-practices/gitlab-jenkins-harbor-java-springboot.zh/)
 
 ## 支持的DevOps工具
 

cmd/devstream/apply.go

@@ -2,10 +2,10 @@ package main
 
 import (
 	"os"
+	"strings"
 
 	"github.com/spf13/cobra"
 
-	"github.com/devstream-io/devstream/internal/pkg/completion"
 	"github.com/devstream-io/devstream/internal/pkg/pluginengine"
 	"github.com/devstream-io/devstream/pkg/util/log"
 )
@@ -20,19 +20,20 @@ DevStream will generate and execute a new plan based on the config file and the
 }
 
 func applyCMDFunc(cmd *cobra.Command, args []string) {
+	checkConfigFile()
 	log.Info("Apply started.")
 	if err := pluginengine.Apply(configFilePath, continueDirectly); err != nil {
 		log.Errorf("Apply failed => %s.", err)
+		if strings.Contains(err.Error(), "config not valid") {
+			log.Info("It seems your config file is not valid. Please check the official documentation https://docs.devstream.io, or use the \"dtm show config\" command to get an example.")
+		}
 		os.Exit(1)
 	}
 	log.Success("Apply finished.")
 }
 
 func init() {
-	applyCMD.Flags().StringVarP(&configFilePath, configFlagName, "f", "config.yaml", "config file")
-	applyCMD.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", defaultPluginDir, "plugins directory")
-	applyCMD.Flags().BoolVarP(&continueDirectly, "yes", "y", false, "apply directly without confirmation")
-
-	completion.FlagFilenameCompletion(applyCMD, configFlagName)
-	completion.FlagDirnameCompletion(applyCMD, pluginDirFlagName)
+	addFlagConfigFile(applyCMD)
+	addFlagPluginDir(applyCMD)
+	addFlagContinueDirectly(applyCMD)
 }

cmd/devstream/common.go

@@ -1,5 +1,15 @@
 package main
 
+import (
+	"os"
+	"strings"
+
+	"github.com/spf13/cobra"
+
+	"github.com/devstream-io/devstream/internal/pkg/completion"
+	"github.com/devstream-io/devstream/pkg/util/log"
+)
+
 var (
 	configFilePath   string
 	pluginDir        string
@@ -11,3 +21,24 @@ const (
 	pluginDirFlagName = "plugin-dir"
 	defaultPluginDir  = "~/.devstream/plugins"
 )
+
+func checkConfigFile() {
+	if strings.TrimSpace(configFilePath) == "" {
+		log.Errorf(`Config file is required. You could use "-f filename" or "-f directory" to specify it.`)
+		os.Exit(1)
+	}
+}
+
+func addFlagConfigFile(cmd *cobra.Command) {
+	cmd.Flags().StringVarP(&configFilePath, configFlagName, "f", "", "config file or directory")
+	completion.FlagFilenameCompletion(cmd, configFlagName)
+}
+
+func addFlagPluginDir(cmd *cobra.Command) {
+	cmd.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", defaultPluginDir, "plugins directory")
+	completion.FlagDirnameCompletion(cmd, pluginDirFlagName)
+}
+
+func addFlagContinueDirectly(cmd *cobra.Command) {
+	cmd.Flags().BoolVarP(&continueDirectly, "yes", "y", false, "continue directly without confirmation")
+}

cmd/devstream/delete.go

@@ -5,7 +5,6 @@ import (
 
 	"github.com/spf13/cobra"
 
-	"github.com/devstream-io/devstream/internal/pkg/completion"
 	"github.com/devstream-io/devstream/internal/pkg/pluginengine"
 	"github.com/devstream-io/devstream/pkg/util/log"
 )
@@ -21,6 +20,7 @@ DevStream will delete everything defined in the config file, regardless of the s
 }
 
 func deleteCMDFunc(cmd *cobra.Command, args []string) {
+	checkConfigFile()
 	log.Info("Delete started.")
 	if err := pluginengine.Remove(configFilePath, continueDirectly, isForceDelete); err != nil {
 		log.Errorf("Delete error: %s.", err)
@@ -31,11 +31,9 @@ func deleteCMDFunc(cmd *cobra.Command, args []string) {
 }
 
 func init() {
-	deleteCMD.Flags().BoolVarP(&isForceDelete, "force", "", false, "force delete by config")
-	deleteCMD.Flags().StringVarP(&configFilePath, configFlagName, "f", "config.yaml", "config file")
-	deleteCMD.Flags().StringVarP(&pluginDir, pluginDirFlagName, "d", defaultPluginDir, "plugins directory")
-	deleteCMD.Flags().BoolVarP(&continueDirectly, "yes", "y", false, "delete directly without confirmation")
+	addFlagConfigFile(deleteCMD)
+	addFlagPluginDir(deleteCMD)
+	addFlagContinueDirectly(deleteCMD)
 
-	completion.FlagFilenameCompletion(deleteCMD, configFlagName)
-	completion.FlagDirnameCompletion(deleteCMD, pluginDirFlagName)
+	deleteCMD.Flags().BoolVarP(&isForceDelete, "force", "", false, "force delete by config")
 }