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

PROPOSAL: Add Codacy to check code quality #552

Open
noelmiller opened this issue Apr 9, 2024 · 4 comments
Open

PROPOSAL: Add Codacy to check code quality #552

noelmiller opened this issue Apr 9, 2024 · 4 comments
Labels
stale Issue has not had recent activity or appears to be solved. Stale issues will be automatically closed

Comments

@noelmiller
Copy link
Member

Since we are considering splitting out our container files into smaller bash scripts (rather than doing inline bash), I think it would be helpful to have a code analysis tool to help with consistency and code quality: https://www.codacy.com/pricing

The open source plan is free and it can be added as a check in Github on a repo.

See JasonN3/build-container-installer#100 as an example.

@noelmiller noelmiller changed the title PROPOSAL: Add Codacy to check code PROPOSAL: Add Codacy to check code quality Apr 9, 2024
@castrojo
Copy link
Member

castrojo commented Apr 9, 2024

+1, I was thinking a shellcheck action but this should be fine to test. I can add it at an org level but would prefer to test it in one repo that isn't main first to get a feel for it.

I don't mind just turning it on as a nonblocking check in bluefin for a while, lmk.

@noelmiller
Copy link
Member Author

+1, I was thinking a shellcheck action but this should be fine to test. I can add it at an org level but would prefer to test it in one repo that isn't main first to get a feel for it.

I don't mind just turning it on as a nonblocking check in bluefin for a while, lmk.

For sure! I think this would be valuable in all repos. We most certainly don't need to turn it on in main first :)

@castrojo
Copy link
Member

I've got this on in Bluefin and a few others and it seems fine. Any other feedback from approvers?

@castrojo castrojo moved this from Todo to Done in Project Goals Apr 28, 2024
@dosubot dosubot bot added the stale Issue has not had recent activity or appears to be solved. Stale issues will be automatically closed label Jul 21, 2024
@dosubot dosubot bot closed this as not planned Won't fix, can't repro, duplicate, stale Jul 28, 2024
@dosubot dosubot bot removed the stale Issue has not had recent activity or appears to be solved. Stale issues will be automatically closed label Jul 28, 2024
@castrojo castrojo reopened this Jul 28, 2024
Copy link

dosubot bot commented Nov 26, 2024

Hi, @noelmiller. I'm Dosu, and I'm helping the Main Repos team manage their backlog. I'm marking this issue as stale.

Issue Summary:

  • You suggested integrating Codacy for code analysis to improve code quality.
  • The plan includes refactoring container files into smaller bash scripts.
  • @castrojo supports the idea and suggests testing Codacy in the Bluefin repository.
  • Initial tests in Bluefin and other repositories show Codacy functioning well.
  • Further feedback from other approvers is awaited.

Next Steps:

  • Is this issue still relevant to the latest version of the Main Repos repository? If so, please comment to keep the discussion open.
  • Otherwise, this issue will be automatically closed in 14 days.

Thank you for your understanding and contribution!

@dosubot dosubot bot added the stale Issue has not had recent activity or appears to be solved. Stale issues will be automatically closed label Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
stale Issue has not had recent activity or appears to be solved. Stale issues will be automatically closed
Projects
Status: Done
Development

No branches or pull requests

2 participants