add connectors concepts in documentation

[lucamrgs]

[github-actions[bot]]

Sigrid maintainability feedback

↗️ You improved your code's maintainability towards your Sigrid objective of 4.0 stars

Show details

Sigrid compared your code against the baseline of 2024-11-07.

👍 What went well?

You fixed or improved 2 refactoring candidates.

Risk	System property	Location
🟠	Unit Size (Improved)	internal/decomposer/decomposer.go Decomposer.ExecuteBranch(stepId string, scopeVariables cacao.Variables)
🟡	Unit Complexity (Improved)	internal/decomposer/decomposer.go Decomposer.ExecuteBranch(stepId string, scopeVariables cacao.Variables)

👎 What could be better?

Unfortunately, 26 refactoring candidates were introduced or got worse.

Risk	System property	Location
🟠	Unit Size (Worsened)	internal/executors/action/action.go Executor.Execute(meta execution.Metadata, metadata PlaybookStepMetadata)
🟠	Unit Size (Worsened)	internal/executors/playbook_action/playbook_action.go PlaybookAction.Execute(metadata execution.Metadata, step cacao.Step, variables cacao.Variables)
🟠	Unit Interfacing (Introduced)	internal/decomposer/decomposer.go New(actionExecutor action.IExecuter, playbookActionExecutor executors.IPlaybookExecuter, condition condition.IExecuter, guid guid.IGuid, reporter reporter.IWorkflowReporter, time timeUtil.ITime)
🟠	Unit Interfacing (Introduced)	internal/reporter/reporter.go Reporter.reportStepEnd(executionId uuid.UUID, step cacao.Step, returnVars cacao.Variables, stepError error, at time.Time)
🟠	Unit Interfacing (Introduced)	internal/reporter/reporter.go Reporter.ReportStepEnd(executionId uuid.UUID, step cacao.Step, returnVars cacao.Variables, stepError error, at time.Time)
🟠	Unit Interfacing (Introduced)	internal/reporter/downstream_reporter/cache/cache.go Cache.upateEndExecutionStep(executionId uuid.UUID, stepId string, returnVars cacao.Variables, stepError error, acceptedStepStati []cache_report.Status, at time.Time)
🟠	Unit Interfacing (Introduced)	internal/reporter/downstream_reporter/cache/cache.go Cache.ReportStepEnd(executionId uuid.UUID, step cacao.Step, returnVars cacao.Variables, stepError error, at time.Time)
🟡	Unit Size (Introduced)	internal/reporter/downstream_reporter/cache/cache.go Cache.upateEndExecutionStep(executionId uuid.UUID, stepId string, returnVars cacao.Variables, stepError error, acceptedStepStati []cache_report.Status, at time.Time)
⚫️		+ 18 more

📚 Remaining technical debt

10 refactoring candidates didn't get better or worse, but are still present in the code you touched.

View this system in Sigrid** to explore your technical debt

⭐️ Sigrid ratings

System property	System on 2024-11-07	Before changes	New/changed code
Volume	5.5	N/A	N/A
Duplication	4.3	4.7	5.5
Unit Size	2.4	2.3	2.3
Unit Complexity	2.6	2.2	2.3
Unit Interfacing	2.4	1.3	0.8
Module Coupling	3.7	5.5	5.5
Component Independence	0.5	N/A	N/A
Component Entanglement	2.9	N/A	N/A
Maintainability	3.0	3.4	3.5

---

Did you find this feedback helpful?

We would like to know your thoughts to make Sigrid better. Your username will remain confidential throughout the process.

• ✅ Yes, these findings are useful
• 🔸 The findings are false positives
• 🔹 These findings are not so important to me

---

View this system in Sigrid