Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

add connectors concepts in documentation #235

Open
wants to merge 3 commits into
base: development
Choose a base branch
from
Open

add connectors concepts in documentation #235

wants to merge 3 commits into from
+68 −19

Conversation

lucamrgs
Copy link
Collaborator

No description provided.

@lucamrgs lucamrgs linked an issue Oct 23, 2024 that may be closed by this pull request
connector reporters documentation #234
Open
@github-actions GitHub Actions
Copy link

github-actions bot commented Oct 23, 2024 •
edited
Loading

Sigrid maintainability feedback

⚠️ Your code did not improve towards your Sigrid objective of 4.0 stars

Sigrid compared your code against the baseline of 2024-10-14.

👍 What went well?

You fixed or improved 0 refactoring candidates.

👎 What could be better?

Unfortunately, 3 refactoring candidates were introduced or got worse.

Risk System property Location
🟠 Unit Size
(Worsened)		 internal/executors/action/action.go
Executor.ExecuteActionStep(metadata execution.Metadata, command cacao.Command, authentication cacao.AuthenticationInformation, target cacao.AgentTarget, variables cacao.Variables, agent cacao.AgentTarget)
🟠 Unit Interfacing
(Worsened)		 internal/executors/action/action.go
Executor.ExecuteActionStep(metadata execution.Metadata, command cacao.Command, authentication cacao.AuthenticationInformation, target cacao.AgentTarget, variables cacao.Variables, agent cacao.AgentTarget)
🟡 Unit Complexity
(Introduced)		 internal/executors/action/action.go
Executor.ExecuteActionStep(metadata execution.Metadata, command cacao.Command, authentication cacao.AuthenticationInformation, target cacao.AgentTarget, variables cacao.Variables, agent cacao.AgentTarget)

📚 Remaining technical debt

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

Risk System property Location
🟠 Unit Size
(Unchanged)		 internal/executors/action/action.go
Executor.Execute(meta execution.Metadata, metadata PlaybookStepMetadata)
🟡 Unit Complexity
(Unchanged)		 internal/executors/action/action.go
Executor.Execute(meta execution.Metadata, metadata PlaybookStepMetadata)

Sigrid ratings

System property System on 2024-10-14 Before changes New/changed code
Volume 5.5 N/A N/A
Duplication 4.3 5.5 5.5
Unit Size 2.4 1.1 0.6
Unit Complexity 2.5 1.9 0.5
Unit Interfacing 2.3 0.5 0.5
Module Coupling 3.7 N/A N/A
Component Independence 5.4 N/A N/A
Component Entanglement 2.4 N/A N/A
Maintainability 3.6 2.4 1.7

View this system in Sigrid

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.

@lucamrgs lucamrgs changed the title add connectors concepts in documentation and mention for catalyst add connectors concepts in documentation Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

connector reporters documentation
1 participant
@lucamrgs