github / codeql-action

Actions for running CodeQL analysis
MIT License
1.14k stars 313 forks source link

Add support for using zstd-compressed nightly bundles #2442

Closed henrymercer closed 2 weeks ago

henrymercer commented 3 weeks ago

We are currently experimenting with using bundles compressed using Zstandard (zstd) rather than gzip to potentially save a significant chunk of the time we spend extracting the bundle. This could lead to a noticeable analysis speedup, particularly for small codebases where fixed costs represent a higher proportion of the total runtime.

This PR is one of the first steps. Specifically:

Merge / deployment checklist

henrymercer commented 2 weeks ago

Thanks for the review!

  • is there a reason we're only supporting for nightly bundles so far? (maybe I've missed the context behind that)

Only that we haven't had a stable release with a zstd bundle yet. My thinking was that it would be easier to write and test the functionality for stable versions once we have a stable zstd bundle.

  • should we expose this in an experimental changenote or will we do that once we've deemed the experiment a success?

I was thinking no since this only applies to nightly bundles which we haven't advertised before, but I don't feel strongly about it.

aeisenberg commented 2 weeks ago
  • should we expose this in an experimental changenote or will we do that once we've deemed the experiment a success?

I was thinking no since this only applies to nightly bundles which we haven't advertised before, but I don't feel strongly about it.

When we're confident about this being a positive improvement, we will go through a proper release channel just to make sure we put out a changelog note and update documentation.