Merge pull request #5 from charlie0129/docs-roadmap

Docs: refine roadmap

Author: wonderflow

.github/workflows/go-build-check.yaml renamed to .github/workflows/go-checks.yaml

@@ -27,7 +27,7 @@ jobs:
         uses: fkirc/[email protected]
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          paths_ignore: '["**.md", "**.mdx", "**.png", "**.jpg"]'
+          paths_ignore: '["**.md", "**.mdx", "**.png", "**.jpg", "**.svg"]'
           do_not_skip: '["workflow_dispatch", "schedule", "push"]'
           concurrent_skipping: false
 

.github/workflows/release-binary.yaml

@@ -9,6 +9,9 @@ on:
 permissions:
   contents: write
 
+env:
+  GO_VERSION: '1.17'
+
 jobs:
   kube-trigger:
     name: Release kube-trigger binaries
@@ -17,6 +20,21 @@ jobs:
       - name: Checkout Code
         uses: actions/checkout@v3
 
+      - name: Setup Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      - name: Setup Go Caches
+        uses: actions/cache@v3
+        with:
+          path: |
+            ~/.cache/go-build
+            ~/go/pkg/mod
+          key: ${{ runner.os }}-golang-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-golang-
+
       - name: Show Make Variables
         run: ./make-kt variables
 

.github/workflows/upload-test-binary.yaml

@@ -15,18 +15,45 @@ on:
 
 env:
   GOLANGCI_VERSION: 'v1.47.2'
+  GO_VERSION: '1.17'
 
 jobs:
+  detect-noop:
+    runs-on: ubuntu-latest
+    outputs:
+      noop: ${{ steps.noop.outputs.should_skip }}
+    steps:
+      - name: Detect No-op Changes
+        id: noop
+        uses: fkirc/[email protected]
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          paths_ignore: '["**.md", "**.mdx", "**.png", "**.jpg", "**.svg"]'
+          do_not_skip: '["workflow_dispatch", "schedule", "push"]'
+          concurrent_skipping: false
+
   upload-test-binary:
+    needs: detect-noop
+    if: needs.detect-noop.outputs.noop != 'true'
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Code
         uses: actions/checkout@v3
 
-      - name: Lint
-        uses: golangci/golangci-lint-action@v3
+      - name: Setup Go
+        uses: actions/setup-go@v3
+        with:
+          go-version: ${{ env.GO_VERSION }}
+
+      - name: Setup Go Caches
+        uses: actions/cache@v3
         with:
-          version: ${{ env.GOLANGCI_VERSION }}
+          path: |
+            ~/.cache/go-build
+            ~/go/pkg/mod
+          key: ${{ runner.os }}-golang-${{ hashFiles('**/go.sum') }}
+          restore-keys: |
+            ${{ runner.os }}-golang-
 
       - name: Run Go Generate
         run: make generate

README.md

@@ -280,3 +280,60 @@ Default: `100`
 | CLI               | ENV             | KubeTrigger CRD      |
 |-------------------|-----------------|----------------------|
 | `--registry-size` | `REGISTRY_SIZE` | `.spec.registrySize` |
+
+## Roadmap
+
+### v0.0.1-alpha.x
+
+- [x] Basic build infrastructure
+- [x] Complete a basic proof-of-concept sample
+- [x] linters, license checker
+- [x] GitHub Actions
+- [x] Rate-limited worker
+- [x] Make the configuration as CRD, launch new process/pod for new watcher
+- [x] Notification for more than one app: selector from compose of Namespace; Labels; Name
+- [x] Refine README, quick starts
+- [ ] Refactor CRD according to [#2](https://github.com/kubevela/kube-trigger/issues/2)
+
+### v0.0.1-beta.x
+
+Code enhancements
+
+- [ ] Add missing unit tests
+- [ ] Add missing integration tests
+
+### v0.0.x
+
+User experience
+
+- [ ] Refine health status of CRs
+- [ ] Make it run as Addon, build component definition, and examples
+- [ ] Kubernetes dynamic admission control with validation webhook
+
+### v0.1.x
+
+Webhook support
+
+- [ ] Contribution Guide
+- [ ] New Action: webhook
+- [ ] New Source: webhook
+
+### v0.2.x
+
+Observability
+
+- [ ] New Action: execute VelaQL(CUE and K8s operations)
+- [ ] New Source: cron
+- [ ] New Action: notifications(email, dingtalk, slack, telegram)
+- [ ] New Action: log (loki, clickhouse)
+
+### Planned for later releases
+
+- [ ] Allow user set custom RBAC for each TriggerInstance
+- [ ] New Action: workflow-run
+- [ ] New Action: execute-command
+- [ ] New Action: metric (prometheus)
+- [ ] Refine controller logic
+- [ ] Remove cache informer, make it with no catch but list watch events with unique queue.
+
+