-
Notifications
You must be signed in to change notification settings - Fork 384
Add a codeql-path output to the init action #291
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
Conversation
233de10
to
77f914a
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍 Awesome. It ended up being an even smaller change than I hoped and it seems like people will find it useful.
Co-authored-by: Chris Gavin <[email protected]>
a09a301
to
f1e2256
Compare
3951135
to
68ca540
Compare
Also add example from README into workflow to confirm it is accurate.
68ca540
to
c87f302
Compare
I can't see an obvious way to test this feature other than the pair of integration tests I've added. The build will break if this feature stops working for any reason - is that good enough coverage?
I'm not super happy with the README changes. It feels like something is missing or the tone doesn't quite match the copy above. Happy to take suggestions for better wording. ✍️ Also I reference
|
As this is an advanced usage it makes more sense to work to getting this included in the documentation instead.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep, I can see this is probably hard to test directly without it just being an assertion that codeQLCmd
is correct, which is already tested in a bunch of other places.
Having the test in the workflow is pretty nice, even if it's not very explicit about what it's testing.
@@ -19,7 +19,7 @@ jobs: | |||
with: | |||
languages: javascript | |||
config-file: ./.github/codeql/codeql-config.yml | |||
# example from README.md | |||
# confirm steps.init.outputs.codeql-path points to the codeql binary |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have left a comment of intent to hopefully make it more clear why this step is in the workflow 👍
I've added a bare bones implemention of the codeql-path output variable. Opening this PR to get feedback and check it is aligned with expectations. 👍
Merge / deployment checklist