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.

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

Link to file in branch from Sigrid CI feedback. #610

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

dennis-sig
Copy link
Contributor

@dennis-sig dennis-sig commented Feb 11, 2025

@patveck This overlaps a bit with some of the investigation work we did into on-premise Sigrid. The nice thing about Sigrid CI, is that this pull request actually shows the change in action :)

You might wonder why I'm not just using Platform.isGitHub() instead of checking for the specific environment variables. That because those environment variables are not available in all cases. If people accidentally misconfigure Sigrid CI, it would crash due to the missing environment variables. With the current behavior they just don't get the link, which is still a lot better than crashing.

@dennis-sig dennis-sig self-assigned this Feb 11, 2025
Copy link

github-actions bot commented Feb 11, 2025

Sigrid maintainability feedback

✅ You wrote maintainable code and achieved your objective of 3.5 stars

Show details

Sigrid compared your code against the baseline of 2025-02-12.

👍 What went well?

You fixed or improved 0 refactoring candidates.

👎 What could be better?

Unfortunately, 5 refactoring candidates were introduced or got worse.

Risk System property Location
🔴 Duplication
(Introduced)
sigridci/sigridci/reports/osh_markdown_report.py line 25-33
sigridci/sigridci/reports/security_markdown_report.py line 31-39
🟠 Module Coupling
(Worsened)
sigridci/sigridci/reports/report.py
🟡 Unit Size
(Introduced)
sigridci/sigridci/platform.py
Platform.createPullRequestFileURL(file,line)
🟡 Unit Interfacing
(Introduced)
sigridci/sigridci/reports/report.py
MarkdownRenderer.decorateLink(label,file,line)
🟡 Unit Interfacing
(Introduced)
sigridci/sigridci/reports/maintainability_markdown_report.py
MaintainabilityMarkdownReport.formatRefactoringCandidateOccurrence(label,rc,occurrence)

📚 Remaining technical debt

14 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 2025-02-12 Before changes New/changed code
Volume 5.5 N/A N/A
Duplication 5.3 4.4 4.3
Unit Size 4.5 4.7 4.6
Unit Complexity 4.0 4.6 4.7
Unit Interfacing 2.6 2.3 2.3
Module Coupling 3.3 1.9 1.9
Component Independence N/A N/A N/A
Component Entanglement N/A N/A N/A
Maintainability 4.2 3.6 3.6

💬 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.


View this system in Sigrid

@dennis-sig dennis-sig requested a review from patveck February 12, 2025 08:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants