You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/codeql/codeql-cli/creating-codeql-databases.rst
+13-14Lines changed: 13 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -233,7 +233,7 @@ Using indirect build tracing
233
233
234
234
If the CodeQL CLI autobuilders for compiled languages do not work with your CI workflow and you cannot wrap invocations of build commands with ``codeql database trace-command``, you can use indirect build tracing to create a CodeQL database. To use indirect build tracing, your CI system must be able to set custom environment variables for each build action.
235
235
236
-
CodeQL databases are created with indirect build tracing when you run the following command from the checkout root of your project:
236
+
To create a CodeQL database with indirect build tracing, run the following command from the checkout root of your project:
237
237
238
238
::
239
239
@@ -250,7 +250,7 @@ You may specify other options for the ``codeql database init`` command as normal
250
250
251
251
.. pull-quote:: Note
252
252
253
-
If you are on Windows, set either ``--trace-process-level <number>`` or ``--trace-process-name <parent process name>`` so that the option points to a parent CI process that will observe all build steps for the code being analyzed.
253
+
If the build runs on Windows, you must set either ``--trace-process-level <number>`` or ``--trace-process-name <parent process name>`` so that the option points to a parent CI process that will observe all build steps for the code being analyzed.
254
254
255
255
256
256
The ``codeql database init`` command will output a message::
@@ -262,16 +262,14 @@ The ``codeql database init`` command will output a message::
262
262
263
263
Based on your operating system, we recommend you run: ...
264
264
265
-
The ``codeql database init`` command will produce files in ``<database>/temp/tracingEnvironment`` containing environment variables and their values for CodeQL to trace subsequent build steps. These files are named ``start-tracing.{json,sh,bat,ps1}``. Use one of these files with your CI system's mechanism for setting environment variables for future steps. You can:
265
+
The ``codeql database init`` command creates ``<database>/temp/tracingEnvironment`` with files that contain environment variables and values that will enable CodeQL to trace a sequence of build steps. These files are named ``start-tracing.{json,sh,bat,ps1}``. Use one of these files with your CI system's mechanism for setting environment variables for future steps. You can:
266
266
267
267
* Read the JSON file, process it, and print out environment variables in the format expected by your CI system. For example, Azure DevOps expects ``echo "##vso[task.setvariable variable=NAME]VALUE"``.
268
-
* Or source the ``sh/bat/ps1`` script so that its variables go into your shell environment.
268
+
* Or source the appropriate ``start-tracing`` script to set the CodeQL variables in the shell environment of the CI system.
269
269
270
-
Build your code, end build tracing, and then run the command ``codeql database finalize <database>``.
270
+
Build your codeand then run the command ``codeql database finalize <database>``. Optionally, after building the code, unset the environment variables using an ``end-tracing.{json,sh,bat,ps1}`` script from the directory where the ``start-tracing`` scripts are stored.
271
271
272
-
You can optionally clean up the environment variables by following the same process as with the ``--begin-tracing`` scripts, except now with ``end-tracing.{json,sh,bat,ps1}`` scripts in the same directory.
273
-
274
-
Once you have created a CodeQL database using indirect build tracing, you can work with it like any other CodeQL database. For example, analyze the database, and upload the results if using Code Scanning.
272
+
Once you have created a CodeQL database using indirect build tracing, you can work with it like any other CodeQL database. For example, analyze the database, and upload the results to GitHub if you use code scanning.
275
273
276
274
Example of creating a CodeQL database using indirect build tracing
0 commit comments