Add a 'source-root' input to the init Action by mario-campos · Pull Request #607 · github/codeql-action (original) (raw)

added 3 commits

June 29, 2021 15:16

This input is exposed in the CodeQL CLI as the flag --source-root, allowing users of the CLI to set --source-root different from --working-dir. However, in codeql-action, these two paths are conflated and it poses problems for users with complicated build environments, in which a source root may be a child of the working directory.

Most users should not notice this, as the default value is ${{ github.workspace }}, as it is implied now (path.resolve()).

In the previous commit, the default value of the input is ${{ github.workspace }} which means that most uses of this input would probably prefix their paths with ${{ github.workspace }}, especially since actions/checkout's 'path' input must be under ${{ github.workspace }}. Therefore, it doesn't make much sense for this to be an absolute file path.

Instead, it's more intuitive to make this relative to the repository.

It causes the action to break (or rather that context being unavailable causes it to fail), despite it being in the description field.

Previously, I had tried to refer to '${{ github.workspace }}', but that caused a problem in Actions. Trying to avoid the issue, I changed this to "the workspace," but this gives up quite a bit of specificity.

Co-authored-by: Arthur Baars aibaars@github.com

Thanks to @aibaars, path.resolve() should will nicely handle more use-cases, namely absolute paths better than path.join().

Co-authored-by: Arthur Baars aibaars@github.com

This config file 'ought to have some queries good for testing!

The test is not related to packaging.

Co-authored-by: Aditya Sharad 6874315+adityasharad@users.noreply.github.com

Moving the files into ../action was causing the job to fail because it couldn't find the test directory anymore. According to @adityasharad, these 'mv's should not be necessary. Removing these means changing the path to the actions.

I'm also removing the 'config-file' input to keep the test minimal. I think this will mean that CodeQL will use the default query suite, so I hope that this doesn't change the results.

…tion into source-root-input

As this test is using only JS, it's not necessary to compile or analyze the other languages.

This is for PR #607, 'source-root' input test case.

Co-authored-by: Aditya Sharad 6874315+adityasharad@users.noreply.github.com