Skip to content

Improve the code analysis workflow with quality checks #13830

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

Merged
merged 1 commit into from
Jul 31, 2021

Conversation

timvandermeij
Copy link
Contributor

@timvandermeij timvandermeij commented Jul 31, 2021

This allows us to get the quality checks that LGTM does into GitHub Advanced Security. Since it not only runs security checks anymore, the workflow is also renamed to CodeQL to make this more explicit (and this matches the documentation better).

@Snuffleupagus Now that we run the security and quality checks, in other words all checks that CodeQL provides, we get more results, mostly the same as LGTM but I think even some new ones (for example https://github.com/timvandermeij/pdf.js/security/code-scanning/103?query=ref%3Arefs%2Fheads%2Fcodeql). Please see https://github.com/timvandermeij/pdf.js/security/code-scanning?query=is%3Aopen+branch%3Acodeql+ for the test run. Once this is merged, we can classify the list of security/quality issues and after that disable LGTM.

This allows us to get the quality checks that LGTM does into GitHub
Advanced Security. Since it not only runs security checks anymore, the
workflow is also renamed to CodeQL to make this more explicit (and this
matches the documentation better).
@Snuffleupagus
Copy link
Collaborator

mostly the same as LGTM but I think even some new ones (for example https://github.com/timvandermeij/pdf.js/security/code-scanning/103?query=ref%3Arefs%2Fheads%2Fcodeql). Please see https://github.com/timvandermeij/pdf.js/security/code-scanning?query=is%3Aopen+branch%3Acodeql+ for the test run.

I'm not able to access either of those links, they just bring up the standard GitHub "Page not found"-page.

Without having seen the output you're referring to, are the new alerts perhaps coming from the fact that we're explicitly ignoring a couple of queries in the https://github.com/mozilla/pdf.js/blob/master/lgtm.yml file? If so, any chance that we can just disable those in this configuration file as well?

@timvandermeij
Copy link
Contributor Author

timvandermeij commented Jul 31, 2021

I have added you as a collaborator to my fork, so once that invite is accepted those links should hopefully work. It's indeed mostly in test files, so we can either choose to ignore them in the configuration file here too, or silence them once by hand in the interface. It might be a bit nicer to exclude it there so all excludes are in a single place instead of in the interface and in the configuration file?

@Snuffleupagus
Copy link
Collaborator

I have added you as a collaborator to my fork, so once that invite is accepted those links should hopefully work.

Thank you; I've looked through the results now, so feel free to remove my access again :-)

It might be a bit nicer to exclude it there so all excludes are in a single place instead of in the interface and in the configuration file?

I suppose that's a point that I cannot argue with, so let's keep it as-is and we can always change that later on!

Copy link
Collaborator

@Snuffleupagus Snuffleupagus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thank you!

@timvandermeij
Copy link
Contributor Author

Thank you for checking! I have removed the access again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants