fix: update .md doc, functions

Author: lfbdev

docs/plugins/trello-github-integ_plugin.md

@@ -1,6 +1,6 @@
 ## 1 `trello-github-integ` Plugin
 
-This plugin creates a new github actions file(trello-github-integration) and upload to your GitHub repo.
+This plugin creates a new GitHub Actions file(trello-github-integration) and upload to your GitHub repo.
 
 ## 2 Usage:
 
@@ -24,7 +24,7 @@ tools:
     owner: YOUR_GITHUB_USERNAME
     # the repo where you'd like to setup GitHub Actions; please change the value below.
     repo: YOUR_REPO_NAME
-    # reference from dependency
+    # reference parameters come from dependency, their usage will be explained later
     boardId: ${{ default.trello.outputs.boardId }}
     todoListId: ${{ default.trello.outputs.todoListId }}
     doingListId: ${{ default.trello.outputs.doingListId }}
@@ -42,26 +42,26 @@ See the example below:
 ```yaml
 ---
 tools:
-  - name: default
+  - name: trello_init_demo
     plugin:
       kind: trello
       version: 0.2.0
     options:
       owner: lfbdev
       repo: golang-demo
       kanbanBoardName: kanban-name
-  - name: default_trello_github
+  - name: trello_github_integ_demo
     plugin:
       kind: trello-github-integ
       version: 0.2.0
-    dependsOn: ["default.trello"]
+    dependsOn: ["trello_init_demo.trello"]
     options:
       owner: lfbdev
       repo: golang-demo
-      boardId: ${{ default.trello.outputs.bid }}
-      todoListId: ${{ default.trello.outputs.todoid }}
-      doingListId: ${{ default.trello.outputs.doingid }}
-      doneListId: ${{ default.trello.outputs.doneid }}
+      boardId: ${{ trello_init_demo.trello.outputs.boardId }}
+      todoListId: ${{ trello_init_demo.trello.outputs.todoListId }}
+      doingListId: ${{ trello_init_demo.trello.outputs.doingListId }}
+      doneListId: ${{ trello_init_demo.trello.outputs.doneListId }}
       branch: main
 ```
 

docs/plugins/trello_plugin.md

@@ -44,28 +44,26 @@ See the example below:
 ```yaml
 ---
 tools:
-  - name: default
+  - name: trello_init_demo
     plugin:
       kind: trello
       version: 0.2.0
     options:
       owner: lfbdev
       repo: golang-demo
       kanbanBoardName: kanban-name
-  - name: default_trello_github
+  - name: trello_github_integ_demo
     plugin:
       kind: trello-github-integ
       version: 0.2.0
-    dependsOn: ["default.trello"]
+    dependsOn: ["trello_init_demo.trello"]
     options:
       owner: lfbdev
       repo: golang-demo
-      api:
-        name: trello
-        boardId: ${{ default.trello.outputs.bid }}
-        todoListId: ${{ default.trello.outputs.todoid }}
-        doingListId: ${{ default.trello.outputs.doingid }}
-        doneListId: ${{ default.trello.outputs.doneid }}
+      boardId: ${{ trello_init_demo.trello.outputs.boardId }}
+      todoListId: ${{ trello_init_demo.trello.outputs.todoListId }}
+      doingListId: ${{ trello_init_demo.trello.outputs.doingListId }}
+      doneListId: ${{ trello_init_demo.trello.outputs.doneListId }}
       branch: main
 ```
 

internal/pkg/pluginengine/change.go

@@ -103,7 +103,7 @@ func execute(smgr statemanager.Manager, changes []*Change) map[string]error {
 
 		log.Info("tool raw changes: ", c.Tool.Options)
 		// fill ref inputs
-		err = FillInputParams(smgr, c.Tool.Options)
+		err = fillRefValueWithOutputs(smgr, c.Tool.Options)
 		if err != nil {
 			succeeded = false
 		}
@@ -184,7 +184,7 @@ func handleResult(smgr statemanager.Manager, change *Change) error {
 }
 
 // FillInputParams fill inputs from state
-func FillInputParams(smgr statemanager.Manager, options map[string]interface{}) error {
+func fillRefValueWithOutputs(smgr statemanager.Manager, options map[string]interface{}) error {
 	// traverse options
 	for key, value := range options {
 		log.Debugf("Key: %s,  Value: %s.", key, value)
@@ -199,8 +199,12 @@ func FillInputParams(smgr statemanager.Manager, options map[string]interface{})
 					return errors.New("ref input format is not correct: " + ref)
 				}
 
-				outputs := smgr.GetOutputs(refParam)
+				outputs, err := smgr.GetOutputs(statemanager.GenStateKey(refParam))
+				if err != nil {
+					return err
+				}
 				log.Debug("Ref outputs: ", outputs)
+
 				if outs, ok := outputs.(map[string]interface{}); ok {
 					log.Debug("Ref outs: ", outs)
 					log.Debug("Ref param: ", refParam[3])
@@ -213,7 +217,7 @@ func FillInputParams(smgr statemanager.Manager, options map[string]interface{})
 		}
 		// judge wheter the format is map[string]interface{}, if true, then recursion
 		if _, ok := value.(map[string]interface{}); ok {
-			if err := FillInputParams(smgr, value.(map[string]interface{})); err != nil {
+			if err := fillRefValueWithOutputs(smgr, value.(map[string]interface{})); err != nil {
 				return err
 			}
 		}

internal/pkg/statemanager/manager.go

@@ -1,6 +1,7 @@
 package statemanager
 
 import (
+	"errors"
 	"fmt"
 
 	"gopkg.in/yaml.v3"
@@ -28,7 +29,7 @@ type Manager interface {
 	AddState(key StateKey, state State) error
 	UpdateState(key StateKey, state State) error
 	DeleteState(key StateKey) error
-	GetOutputs(refParam []string) interface{}
+	GetOutputs(key StateKey) (interface{}, error)
 }
 
 // manager is the default implement with Manager
@@ -108,7 +109,10 @@ func (m *manager) DeleteState(key StateKey) error {
 	return m.Write(m.GetStatesMap().Format())
 }
 
-func (m *manager) GetOutputs(refParam []string) interface{} {
-	state := m.GetState(GenStateKey(refParam))
-	return state.Resource["outputs"]
+func (m *manager) GetOutputs(key StateKey) (interface{}, error) {
+	state := m.GetState(key)
+	if value, ok := state.Resource["outputs"]; ok {
+		return value, nil
+	}
+	return nil, errors.New(fmt.Sprintf("cannot find outputs from state: %s.", state.Name))
 }