Cleanup CodeQL DBs and output their location for later steps #543
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aeisenberg
reviewed
Jun 3, 2021
analyze/action.yml
Outdated
| @@ -13,6 +13,10 @@ inputs: | |||
| description: Upload the SARIF file | |||
| required: false | |||
| default: "true" | |||
| cleanup-level: | |||
| description: "Level of cleanup to perform on CodeQL databases at the end of the analyze step. This should either be 'none' to skip cleanup, or be a valid argument for the --mode flag of the CodeQL CLI command 'codeql database cleanup'" | |||
There was a problem hiding this comment.
Would be nice if you could list the valid options here. Or maybe provide a link to the documentation (or both).
There was a problem hiding this comment.
I'm hesitant to list the options because it duplicates where we have to make a documentation change if we modify them later. Have added a link to the CLI docs, though.
edoardopirovano
force-pushed
the
output-db-location
branch
from
4ca6678
to
bcb4f48
Compare
edoardopirovano
force-pushed
the
output-db-location
branch
from
bcb4f48
to
ec666f8
Compare
aeisenberg
approved these changes
Jun 4, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR does two things that should facilitate user workflows that want to upload CodeQL databases somewhere:
analyzestep are cleaned up at the end of the step (i.e. items that are not needed to run further queries like evaluation logs and the cache are removed). The level of cleanup performed is configurable via a new parameter of theanalyzestep. I don't think we should expose this in user-facing documentation as most users will just want the default, but it may be useful for internal debugging to have an option there.analyzestep now has an output,db-locationsthat contains a JSON object mapping from languages that a CodeQL database was created for to the location of this database on disk. I've modified one of the PR checks to use this to verify that it is populated correctly.Merge / deployment checklist