Skip to content

Commit 68c2c16

Browse files
committed
Address changes from PR
1 parent 53d8bf2 commit 68c2c16

File tree

2 files changed

+11
-4
lines changed

2 files changed

+11
-4
lines changed

docs/codeql/codeql-cli/about-codeql-workspaces.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,9 @@ About CodeQL Workspaces
55

66
.. include:: ../reusables/beta-note-package-management.rst
77

8-
CodeQL workspaces are used to group multiple CodeQL packs together. CodeQL packs in the same workspace are automatically available as source dependencies for each other when running any CodeQL command that resolves queries. This makes it easier to develope and maintain multiple, related CodeQL packs. A typical use case for a CodeQL workspace is for developing one or more CodeQL library packs and one or more query packs that depends on it in them in the same location.
8+
CodeQL workspaces are used to group multiple CodeQL packs together. A typical use case for a CodeQL workspace is for developing a set of CodeQL library and query packs that are mutually dependent. For more information on CodeQL packs, see ":doc:`About CodeQL packs <about-codeql-packs>`."
99

10-
The main benefit of a CodeQl workspace is that it is easier to develop and maintain multiple CodeQL packs. When a CodeQL workspace is used, all CodeQL packs in the workspace are available as source dependencies for each other when running any CodeQL command that resolves queries. This makes it easier to develope and maintain multiple, related CodeQL packs.
10+
The main benefit of a CodeQl workspace is that it is easier to develop and maintain multiple CodeQL packs. When a CodeQL workspace is used, all CodeQL packs in the workspace are available as *source dependencies* for each other when running any CodeQL command that resolves queries. This makes it easier to develope and maintain multiple, related CodeQL packs.
1111

1212
In most cases, the CodeQL workspace and all CodeQL packs contained in it should be stored in the same git repository so the development environment is more easily sharable.
1313

@@ -16,7 +16,7 @@ The ``codeql-workspae.yml`` file
1616

1717
A CodeQL workspace is defined by a ``codeql-workspace.yml`` yaml file. This file contains a ``provide`` block, and optionally an ``ignore`` block. The ``provide`` block contains a list of glob patterns that define the CodeQL packs that are available in the workspace. The ``ignore`` block contains a list of glob patterns that define CodeQL packs that are not available in the workspace. Each entry in the ``provide`` or ``ignore`` section must map to a path to a ``qlpack.yml`` file. All glob patterns are relative to the directory containing the workspace file. See `@actions/glob <https://github.com/actions/toolkit/tree/main/packages/glob#patterns>` for a list of patterns accepted in this file.
1818

19-
For example, the following ``codeql-workspace.yml`` file defines a workspace that contains all CodeQl packs recursively found in the ``codeql-packs`` directory, except for the packs in the ``experimental`` directory:
19+
For example, the following ``codeql-workspace.yml`` file defines a workspace that contains all CodeQL packs recursively found in the ``codeql-packs`` directory, except for the packs in the ``experimental`` directory:
2020

2121
.. code-block:: yaml
2222
@@ -27,6 +27,7 @@ For example, the following ``codeql-workspace.yml`` file defines a workspace tha
2727
2828
To verify that you have the correct ``codeql-workspace.yml`` file, run ``codeql pack ls`` command in the same directory as your workspace. The result of the command is a list of all CodeQL packs in the workspace.
2929

30+
3031
CodeQL workspaces and query resolution
3132
--------------------------------------
3233

@@ -36,6 +37,12 @@ Similarly, publishing a CodeQL query pack to the GitHub container registry using
3637

3738
This ensures that any local change to a query library in a dependency in the same workspace will be automatically reflected in the published query pack.
3839

40+
.. pull-quote::
41+
42+
Note
43+
44+
Source dependencies are CodeQL packs that are resolved from the filesystem. They might be in the same CodeQL workspace, or specified a path option in the ``--additional-packs`` argument. Source dependencies override any dependencies found in the local package cache and version constraints are ignored. This ensures that during local development version mismatches can be ignored.
45+
3946
Example
4047
~~~~~~~
4148

docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ You can also specify:
8080

8181
- .. include:: ../reusables/threads-query-execution.rst
8282

83-
. pull-quote::
83+
.. pull-quote::
8484

8585
Upgrading databases
8686

0 commit comments

Comments
 (0)