Skip to content

Commit 2dadc75

Browse files
authored
Merge pull request github#5563 from lecoursen/stronger-rec-to-use-lgtm.com-branch
Make stronger recommendations around the use of the lgtm.com branch
2 parents 2f98212 + d57ec5d commit 2dadc75

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

docs/codeql/codeql-cli/getting-started-with-the-codeql-cli.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -121,21 +121,21 @@ see ":doc:`About QL packs <about-ql-packs>`."
121121

122122
There are different versions of the CodeQL queries available for different
123123
users. Check out the correct version for your use case:
124+
125+
- For the queries used on `LGTM.com <https://lgtm.com>`__, check out the
126+
``lgtm.com`` branch. You should use this branch for databases you've built
127+
using the CodeQL CLI, fetched from code scanning on GitHub, or recently downloaded from LGTM.com.
128+
The queries on the ``lgtm.com`` branch are more likely to be compatible
129+
with the ``latest`` CLI, so you'll be less likely to have to upgrade
130+
newly-created databases than if you use the ``main`` branch. Older databases
131+
may need to be upgraded before you can analyze them.
124132

125133
- For the most up to date CodeQL queries, check out the ``main`` branch.
126134
This branch represents the very latest version of CodeQL's analysis. Even
127135
databases created using the most recent version of the CLI may have to be
128136
upgraded before you can analyze them. For more information, see
129137
":doc:`Upgrading CodeQL databases <upgrading-codeql-databases>`."
130-
131-
- For the queries used on `LGTM.com <https://lgtm.com>`__, check out the
132-
``lgtm.com`` branch. You can run these queries on databases you've recently
133-
downloaded from LGTM.com. Older databases may need to be upgraded before
134-
you can analyze them. The queries on the ``lgtm.com`` branch are also more
135-
likely to be compatible with the ``latest`` CLI, so you'll be less likely
136-
to have to upgrade newly-created databases than if you use the ``main``
137-
branch.
138-
138+
139139
- For the queries used in a particular LGTM Enterprise release, check out the
140140
branch tagged with the relevant release number. For example, the branch
141141
tagged ``v1.23.0`` corresponds to LGTM Enterprise 1.23. You must use this

0 commit comments

Comments
 (0)