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

PR Checks: Test codeql-bundle.tar.gz #1822

Merged
merged 5 commits into from
Aug 3, 2023

Conversation

angelapwen
Copy link
Contributor

@angelapwen angelapwen commented Aug 3, 2023

This PR check makes sure that we are testing the case where we use the non-platform specific codeql-bundle.tar.gz file for analysis. To do so, we've added a use-all-platform-bundle input to the prepare-test action that we set to true in the new PR check.

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.

@angelapwen angelapwen force-pushed the test-codeql-bundle-all branch 3 times, most recently from ec8eb0f to 7420f88 Compare August 3, 2023 12:14
@angelapwen angelapwen changed the title PR Checks: Test codeql-bundle-all PR Checks: Test codeql-bundle.tar.gz Aug 3, 2023
@angelapwen angelapwen marked this pull request as ready for review August 3, 2023 12:55
@angelapwen angelapwen requested a review from a team as a code owner August 3, 2023 12:55
Copy link
Contributor

@henrymercer henrymercer 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, just a couple of comments.

@@ -4,6 +4,10 @@ inputs:
version:
description: "The version of the CodeQL CLI to use. Can be 'latest', 'default', 'nightly-latest', 'nightly-YYYY-MM-DD', or 'stable-YYYY-MM-DD'."
required: true
require-codeql-bundle-all:
Copy link
Contributor

Choose a reason for hiding this comment

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

Minor: How about use-all-platform-bundle, to make it more clear what the "all" means?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done!

@@ -0,0 +1,56 @@
name: 'PR Check - CodeQL Bundle All'
Copy link
Contributor

Choose a reason for hiding this comment

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

Optional: We could consider autogenerating this by adding a top-level property to the workflow specifications and forwarding this to prepare-test

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done 😄

Comment on lines +22 to +26
strategy:
matrix:
include:
- os: ubuntu-latest
version: nightly-latest
Copy link
Contributor

Choose a reason for hiding this comment

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

Perhaps matrix over default, latest, nightly-latest to test the three most relevant bundles.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hm... using default or latest doesn't specify the bundle artifact to download in the prepare-test action: https://github.com/github/codeql-action/blob/main/.github/actions/prepare-test/action.yml#L47-L50 🤔

Copy link
Contributor

@henrymercer henrymercer Aug 3, 2023

Choose a reason for hiding this comment

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

Oh, I see, since the Action determines the artifact name in these cases. In which case, I think testing the nightly is good enough.

Copy link
Contributor

@henrymercer henrymercer left a comment

Choose a reason for hiding this comment

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

Very nice!

@angelapwen angelapwen enabled auto-merge (squash) August 3, 2023 15:02
@angelapwen angelapwen merged commit 1f63aba into github:main Aug 3, 2023
344 checks passed
@angelapwen angelapwen deleted the test-codeql-bundle-all branch August 4, 2023 11:51
@github-actions github-actions bot mentioned this pull request Aug 8, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants