FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

Cleanup CodeQL DBs and output their location for later steps by edoardopirovano · Pull Request #543 · github/codeql-action · GitHub

/ codeql-action Public

Cleanup CodeQL DBs and output their location for later steps - #543

Merged
edoardopirovano merged 1 commit into
github:mainfrom
edoardopirovano:output-db-location
Jun 4, 2021
ConversationCommits (1)ChecksFiles changed
Merged

Cleanup CodeQL DBs and output their location for later steps#543
edoardopirovano merged 1 commit into
github:mainfrom
edoardopirovano:output-db-location

Conversation

edoardopirovano commented Jun 3, 2021

Copy link
Copy Markdown
Contributor

This PR does two things that should facilitate user workflows that want to upload CodeQL databases somewhere:

  1. Databases created during the analyze step 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 the analyze step. 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.
  2. The analyze step now has an output, db-locations that 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

  • Confirm this change is backwards compatible with existing workflows.
  • Confirm the readme has been updated if necessary.
  • Confirm the changelog has been updated if necessary.

aeisenberg reviewed Jun 3, 2021
View reviewed changes

aeisenberg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Looks good. A couple of suggestions around comments.

Comment thread analyze/action.yml Outdated
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'"

aeisenberg Jun 3, 2021

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Would be nice if you could list the valid options here. Or maybe provide a link to the documentation (or both).

edoardopirovano Jun 4, 2021

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

Comment thread analyze/action.yml Outdated
aeisenberg reviewed Jun 4, 2021
View reviewed changes

aeisenberg left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

👍🏼

edoardopirovano merged commit ddb83a4 into github:main Jun 4, 2021
edoardopirovano deleted the output-db-location branch June 4, 2021 17:54
github-actions Bot mentioned this pull request Jun 7, 2021
Merged
5 tasks
coderabbitai Bot mentioned this pull request Mar 6, 2025
Merged
This file contains hidden or 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
Show hidden characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

aeisenberg aeisenberg approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

Back | FazBrowse Home | New Git URL