github / codeql-action

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

Add `config-file` to init status report #2443

Closed dbartol closed 2 weeks ago

dbartol commented 2 weeks ago

Testing using a private branch confirm that we're already receiving the telemetry correctly.

Merge / deployment checklist

aeisenberg commented 2 weeks ago

So, this will add the path to the config file to our telemetry? If so, how useful is this for us? More precisely, what questions will this help us answer? Would we get the same value by adding a boolean field something like uses_config_file: true/false?

angelapwen commented 2 weeks ago

So, this will add the path to the config file to our telemetry? If so, how useful is this for us? More precisely, what questions will this help us answer? Would we get the same value by adding a boolean field something like uses_config_file: true/false?

From internal issue: it looks like we want to know:

I guess having the path will answer both of those questions. Or we could alternatively have 2 fields in the status report, a boolean for if a config file was used and an enum/string.

The latter would probably make it easier to query (so we have the logic determining whether the file was remote or local in the Action, rather than in the query). On the other hand, we've already merged the changes to the schema/API so changing the shape of the data we send through would require updating those.

dbartol commented 2 weeks ago

We already have to do a similar local vs. remote parsing in the Kusto query for the queries property, so we might as well do the same for the config file path.