Merge pull request #375 from merico-dev/release-0.3.1

feat: prepare for v0.3.1 release

Author: IronCore864

.github/workflows/automated-release.yml

@@ -35,7 +35,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-go-
       - name: Build
-        run: make build
+        run: make build -j8
       - name: Install Github-release
         run: go install github.com/github-release/github-release@latest
       - name: upload
@@ -73,7 +73,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-go-
       - name: Build
-        run: make build
+        run: make build -j8
       - name: Install Github-release
         run: go install github.com/github-release/github-release@latest
       - name: upload

.github/workflows/e2e-test.yml

@@ -29,7 +29,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-go-
       - name: Build
-        run: make build
+        run: make build -j8
       - name: Configure AWS credentials
         uses: aws-actions/configure-aws-credentials@v1
         with:

.github/workflows/main-builder.yml

@@ -25,7 +25,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-go-
       - name: Build
-        run: make build
+        run: make build -j8
       - name: Test
         run: go test -v ./...
   build-and-test-on-macos:
@@ -48,6 +48,6 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-go-
       - name: Build
-        run: make build
+        run: make build -j8
       - name: Test
         run: go test -v ./...

.github/workflows/ut-linux.yml

@@ -25,6 +25,6 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-go-
       - name: Build
-        run: make build
+        run: make build -j8
       - name: Test
         run: go test -v ./...

.github/workflows/ut-mac.yml

@@ -25,6 +25,6 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-go-
       - name: Build
-        run: make build
+        run: make build -j8
       - name: Test
         run: go test -v ./...

Makefile

@@ -1,4 +1,4 @@
-VERSION=0.3.0
+VERSION=0.3.1
 
 MKFILE_PATH=$(abspath $(lastword $(MAKEFILE_LIST)))
 BUILD_PATH=$(patsubst %/,%,$(dir $(MKFILE_PATH)))/build/working_dir
@@ -63,21 +63,6 @@ md5-plugin.%:
 	$(eval plugin_name := $(strip $*))
 	${MD5SUM} .devstream/${plugin_name}-${PLUGIN_SUFFIX}.so > .devstream/${plugin_name}-${PLUGIN_SUFFIX}.md5
 
-
-.PHONY: build-linux-amd64
-build-linux-amd64: ## Cross-platform build for "linux/amd64".
-	echo "Building in ${BUILD_PATH}"
-	mkdir -p .devstream
-	rm -rf ${BUILD_PATH} && mkdir ${BUILD_PATH}
-	docker buildx build --platform linux/amd64 --load -t mericodev/stream-builder:v${VERSION} --build-arg VERSION=${VERSION} -f build/package/Dockerfile .
-	cp -r go.mod go.sum cmd internal pkg build/package/build_linux_amd64.sh ${BUILD_PATH}/
-	chmod +x ${BUILD_PATH}/build_linux_amd64.sh
-	docker run --rm --platform linux/amd64 -v ${BUILD_PATH}:/devstream mericodev/stream-builder:v${VERSION}
-	mv ${BUILD_PATH}/output/*.so .devstream/
-	mv ${BUILD_PATH}/output/*.md5 .devstream/
-	mv ${BUILD_PATH}/output/dtm* .
-	rm -rf ${BUILD_PATH}
-
 .PHONY: fmt
 fmt: ## Run 'go fmt' & goimports against code.
 	goimports -local="github.com/merico-dev/stream" -d -w cmd

build/package/Dockerfile

@@ -1,6 +1,6 @@
 #! /bin/bash -e
 
-tag=v0.4.0
+tag=v0.3.1
 
 user=merico-dev
 repo=stream
@@ -12,7 +12,7 @@ GOARCH=$(go env GOARCH)
 
 # call build core and plugins
 cd ../..
-make build
+make build -j8
 
 # install github-release for uploading
 go install github.com/github-release/github-release@latest

build/package/auto-release-darwin-arm64.sh

@@ -8,7 +8,7 @@ The architecture documentation explains how in general DevStream works. If you h
 - Each _Tool_ has its Name, Plugin, and Options, as defined [here](https://github.com/merico-dev/stream/blob/main/internal/pkg/configloader/config.go#L24).
 - Each _Tool_ can have its dependencies, which are specified by the `dependsOn` keyword.
 
-The dependency `dependsOn` is an array of strings, with each element being a dependency. Each dependency is named in the format of "NAME.KIND". See [here](https://github.com/merico-dev/stream/blob/main/examples/quickstart.yaml#L16) for example.
+The dependency `dependsOn` is an array of strings, with each element being a dependency. Each dependency is named in the format of "NAME.PLUGIN". See [here](https://github.com/merico-dev/stream/blob/main/examples/quickstart.yaml#L16) for example.
 
 ## 2 State
 

build/package/build_linux_amd64.sh

@@ -16,25 +16,23 @@ Notes:
 To use the output, follow this format:
 
 ```
-${{ TOOL_NAME.TOOL_KIND.outputs.OUTPUT_KEY }}
+${{ TOOL_NAME.PLUGIN.outputs.OUTPUT_KEY }}
 ```
 
 For example, given config:
 
 ```yaml
 tools:
 - name: kanban
-  plugin:
-    kind: trello
-    version: 0.3.0
+  plugin: trello
   options:
     owner: IronCore864
     repo: golang-demo
     kanbanBoardName: golang-demo-board
 ```
 
 - TOOL_NAME is "kanban"
-- TOOL_KIND is "trello"
+- PLUGIN is "trello"
 
 If the "trello" plugin has an output key name "boardId", then we can use its value by the following syntax:
 
@@ -50,18 +48,14 @@ Config:
 ---
 tools:
 - name: repo
-  plugin:
-    kind: github-repo-scaffolding-golang
-    version: 0.3.0
+  plugin: github-repo-scaffolding-golang
   options:
     owner: IronCore864
     repo: golang-demo
     branch: main
     image_repo: ironcore864/golang-demo
 - name: cd
-  plugin:
-    kind: argocd
-    version: 0.3.0
+  plugin: argocd
   options:
     create_namespace: true
     repo:
@@ -75,9 +69,7 @@ tools:
       timeout: 10m
       upgradeCRDs: true
 - name: demo
-  plugin:
-    kind: argocdapp
-    version: 0.3.0
+  plugin: argocdapp
   dependsOn: [ "cd.argocd", "demo.github-repo-scaffolding-golang" ]
   options:
     app:
@@ -93,7 +85,7 @@ tools:
 ```
 
 In this example:
-- Tool "demo" (kind: argocdapp) depends on tool "repo" (kind: github-repo-scaffolding-golang);
+- Tool "demo" (plugin: argocdapp) depends on tool "repo" (plugin: github-repo-scaffolding-golang);
 - tool "demo" has an user option "options.source.repoURL", which uses tool "repo" output "repoURL" (`${{ demo.github-repo-scaffolding-golang.outputs.repoURL }}`)
 
 

docs/core_concepts.md

@@ -7,12 +7,8 @@ This plugin installs [ArgoCD](https://argoproj.github.io/cd/) in an existing Kub
 ```yaml
 tools:
 - name: argocd
-  plugin:
-    # name of the plugin
-    kind: argocd
-    # version of the plugin
-    # checkout the version from the GitHub releases
-    version: 0.3.0
+  # name of the plugin
+  plugin: argocd
   options:
     # need to create the namespace or not, default: false
     create_namespace: true

docs/output.md

@@ -14,12 +14,8 @@ This plugin creates an [ArgoCD Application](https://argo-cd.readthedocs.io/en/st
 ```yaml
 tools:
 - name: helloworld
-  plugin:
-    # name of the plugin
-    kind: argocdapp
-    # version of the plugin
-    # checkout the version from the GitHub releases
-    version: 0.3.0
+  # name of the plugin
+  plugin: argocdapp
   # if specified, dtm will make sure the dependency is applied first before handling this tool.
   dependsOn: [ "ARGOCD_TOOL_NAME.argocd" ]
   # options for the plugin
@@ -61,18 +57,14 @@ See the example below:
 ---
 tools:
 - name: go-webapp-repo
-  plugin:
-    kind: github-repo-scaffolding-golang
-    version: 0.2.0
+  plugin: github-repo-scaffolding-golang
   options:
     owner: IronCore864
     repo: go-webapp-devstream-demo
     branch: main
     image_repo: ironcore864/go-webapp-devstream-demo
 - name: go-webapp-argocd-deploy
-  plugin:
-    kind: argocdapp
-    version: 0.2.0
+  plugin: argocdapp
   dependsOn: ["go-webapp-repo.github-repo-scaffolding-golang"]
   options:
     app:
@@ -92,4 +84,4 @@ In the example above:
 - We put `go-webapp-repo.github-repo-scaffolding-golang` as dependency by using the `dependsOn` keyword.
 - We used `go-webapp-repo.github-repo-scaffolding-golang`'s output as input for the `githubactions-golang` plugin.
 
-Pay attention to the `${{ xxx }}` part in the example. `${{ TOOL_NAME.TOOL_KIND.outputs.var}}` is the syntax for using an output.
+Pay attention to the `${{ xxx }}` part in the example. `${{ TOOL_NAME.PLUGIN.outputs.var}}` is the syntax for using an output.

docs/plugins/argocd.md

@@ -9,12 +9,8 @@ Note that this isn't a production-ready installation; it's only meant as an alte
 ```yaml
 tools:
 - name: devlake
-  plugin:
-    # name of the plugin
-    kind: devlake
-    # version of the plugin
-    # checkout the version from the GitHub releases
-    version: 0.3.0
+  # name of the plugin
+  plugin: devlake
 ```
 
 All the parameters in the example above are mandatory.

docs/plugins/argocdapp.md

@@ -25,12 +25,8 @@ If you don't know how to create this token, check out:
 tools:
 # name of the instance with github-repo-scaffolding-golang
 - name: go-webapp-repo
-  plugin:
-    # kind of the plugin
-    kind: github-repo-scaffolding-golang
-    # version of the plugin
-    # checkout the version from the GitHub releases
-    version: 0.3.0
+  # name of the plugin
+  plugin: github-repo-scaffolding-golang
   # 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.
@@ -68,18 +64,14 @@ If, for example, you want to use the outputs as inputs for another plugin, you c
 ---
 tools:
 - name: go-webapp-repo
-  plugin:
-    kind: github-repo-scaffolding-golang
-    version: 0.3.0
+  plugin: github-repo-scaffolding-golang
   options:
     owner: IronCore864
     repo: go-webapp-devstream-demo
     branch: main
     image_repo: ironcore864/go-webapp-devstream-demo
 - name: golang-demo-actions
-  plugin:
-    kind: githubactions-golang
-    version: 0.3.0
+  plugin: githubactions-golang
   dependsOn: ["go-webapp-repo.github-repo-scaffolding-golang"]
   options:
     owner: ${{go-webapp-repo.github-repo-scaffolding-golang.outputs.owner}}
@@ -98,4 +90,4 @@ tools:
       enable: False
 ```
 
-Pay attention to the `${{ xxx }}` part in the example. `${{ TOOL_NAME.TOOL_KIND.outputs.var}}` is the syntax for using an output.
+Pay attention to the `${{ xxx }}` part in the example. `${{ TOOL_NAME.PLUGIN.outputs.var}}` is the syntax for using an output.

docs/plugins/devlake.md

@@ -20,14 +20,10 @@ _If Docker image build/push is enabled (see the example below), you also need to
 ```yaml
 tools:
 - name: golang-demo-app
-  plugin:
-    # name of the plugin
-    kind: githubactions-golang
-    # version of the plugin
-    # checkout the version from the GitHub releases
-    version: 0.3.0
+  # name of the plugin
+  plugin: githubactions-golang
   # optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
-  dependsOn: [ "TOOL1_NAME.TOOL1_KIND", "TOOL2_NAME.TOOL2_KIND" ]
+  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.
@@ -81,18 +77,14 @@ See the example below:
 ---
 tools:
 - name: go-webapp-repo
-  plugin:
-    kind: github-repo-scaffolding-golang
-    version: 0.3.0
+  plugin: github-repo-scaffolding-golang
   options:
     owner: IronCore864
     repo: go-webapp-devstream-demo
     branch: main
     image_repo: ironcore864/go-webapp-devstream-demo
 - name: golang-demo-actions
-  plugin:
-    kind: githubactions-golang
-    version: 0.3.0
+  plugin: githubactions-golang
   dependsOn: ["go-webapp-repo.github-repo-scaffolding-golang"]
   options:
     owner: ${{go-webapp-repo.github-repo-scaffolding-golang.outputs.owner}}
@@ -116,4 +108,4 @@ In the example above:
 - We put `go-webapp-repo.github-repo-scaffolding-golang` as dependency by using the `dependsOn` keyword.
 - We used `go-webapp-repo.github-repo-scaffolding-golang`'s output as input for the `githubactions-golang` plugin.
 
-Pay attention to the `${{ xxx }}` part in the example. `${{ TOOL_NAME.TOOL_KIND.outputs.var}}` is the syntax for using an output.
+Pay attention to the `${{ xxx }}` part in the example. `${{ TOOL_NAME.PLUGIN.outputs.var}}` is the syntax for using an output.