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

Add Code Quality Actions in Github #16

Open
ebresie opened this issue Jun 4, 2022 · 2 comments
Open

Add Code Quality Actions in Github #16

ebresie opened this issue Jun 4, 2022 · 2 comments
Labels
infrastructure For matters relating to Github, build, etc quality This is for code quality related items.

Comments

@ebresie
Copy link
Owner

ebresie commented Jun 4, 2022

Presently build includes basic Github Security Checks (see https://github.com/ebresie/python4nb/security ) however adding additional checks is preferred going forward.

This issue involves updating the CI/Build flow (either during maven build or during other phase) to accommodate additional Code quality actions where applicable. This may include but not limited to

  1. Code Quality Checks (Sonar Scanner)
  2. Security Checks
  3. Test Coverage

Reference:
https://docs.sonarqube.org/latest/analysis/scan/sonarscanner-for-maven/
https://github.com/marketplace/actions/sonarcloud-scan

@ebresie ebresie added infrastructure For matters relating to Github, build, etc quality This is for code quality related items. labels Jun 4, 2022
@ebresie
Copy link
Owner Author

ebresie commented Jun 26, 2022

Trying to add some maven quality / security checks initially, adding plugins to the pom.xml file.

See https://rieckpil.de/top-3-maven-plugins-to-ensure-quality-and-security-for-your-project/ 5.2.2

For Security try
run mvn verify or mvn depencency-check:check
target/dependency-check-report.html

For quality try
spotbug analysis -
mvn spotbugs:check and/or mvn spotbugs:gui

@ebresie
Copy link
Owner Author

ebresie commented Jun 26, 2022

Put these originally in build but due to current failures not addressed, it prevented any subsequent successful builds. Tried putting in reporting section but then had execution and dependencies tag issues. Not sure if this is a maven or plugin version issue (i.e. not supported in given maven or plugin in use - may require plugin version update). For now moving out of build section and commenting out until can resolve issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infrastructure For matters relating to Github, build, etc quality This is for code quality related items.
Projects
None yet
Development

No branches or pull requests

1 participant