Skip to content

Commit 137b068

Browse files
committed
Move Source Dependencies description to its own section
1 parent 2cacba5 commit 137b068

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,17 @@ For example, the following ``codeql-workspace.yml`` file defines a workspace tha
3232
3333
To verify that your ``codeql-workspace.yml`` file includes the CodeQL packs that you expect, run the ``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.
3434

35+
.. _source-dependencies:
36+
37+
Source dependencies
38+
-------------------
39+
40+
Source dependencies are CodeQL packs that are resolved from the local file system outside of the CodeQL package cache. These dependencies can be in the same CodeQL workspace, or specified as a path option using the ``--additional-packs`` argument. When you compile and run queries locally, source dependencies override any dependencies found in the CodeQL package cache as well as version constraints defined in the ``qlpack.yml``. All references to CodeQL packs in the same workspace are resolved as source dependencies.
41+
42+
This is particularly useful in the following situations:
43+
44+
- One of the dependencies of the query pack you are running is not yet published. Resolving from source is the only way to reference that pack.
45+
- You are making changes to multiple packs at the same time and want to test them together. Resolving from source ensures that you are using the version of the pack with your changes in it.
3546

3647
CodeQL workspaces and query resolution
3748
--------------------------------------
@@ -42,17 +53,6 @@ Similarly, when you publish a CodeQL query pack to the GitHub container registry
4253

4354
This ensures that any local changes you make to a query library in a dependency are automatically reflected in any query packs you publish from that workspace.
4455

45-
.. pull-quote::
46-
47-
Note
48-
49-
Source dependencies are CodeQL packs that are resolved from the local file system. These dependencies can be in the same CodeQL workspace, or specified as a path option using the ``--additional-packs`` argument. When you compile and run queries locally, source dependencies override any dependencies found in the local package cache as well as version constraints defined in the ``qlpack.yml``.
50-
51-
This is particularly useful in the following situations:
52-
53-
- One of the dependencies of the query pack you are running is not yet published. Resolving from source is the only way to reference that pack.
54-
- You are making changes to multiple packs at the same time and want to test them together. Resolving from source ensures that you are using the version of the pack with your changes in it.
55-
5656
Example
5757
~~~~~~~
5858

0 commit comments

Comments
 (0)