Skip to content

Commit 5197c2d

Browse files
committed
Move beta note into a reusable
1 parent 84fe272 commit 5197c2d

6 files changed

+11
-31
lines changed

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

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,7 @@
33
About CodeQL packs
44
==================
55

6-
.. pull-quote::
7-
8-
Note
9-
10-
CodeQL packs are currently in beta and subject to change.
6+
.. include:: ../reusables/beta-note-package-manager.rst
117

128
CodeQL packs are used to create, share, depend on, and run CodeQL queries and libraries. You can publish your own CodeQL packs and download packs created by others. CodeQL packs contain queries, library files, query suites, and metadata.
139

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

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -111,11 +111,7 @@ see ":doc:`Using custom queries with the CodeQL CLI <using-custom-queries-with-t
111111
Running a CodeQL pack
112112
~~~~~~~~~~~~~~~~~~~~~
113113

114-
.. pull-quote::
115-
116-
Note
117-
118-
The CodeQL package manager is currently in beta and subject to change. During the beta, CodeQL packs are available only using GitHub Packages - the GitHub Container registry. You must use version 2.5.8 or later of the CodeQL CLI to use the CodeQL package manager.
114+
.. include:: ../reusables/beta-note-package-manager.rst
119115

120116
To run an existing CodeQL query pack from the GitHub Container registry, you need to download it first::
121117

@@ -172,11 +168,7 @@ If the analysis found fewer results for standard queries than you expected, revi
172168
Integrating a CodeQL pack into a code scanning workflow in GitHub
173169
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
174170

175-
.. pull-quote::
176-
177-
Note
178-
179-
The CodeQL package manager is currently in beta and subject to change. During the beta, CodeQL packs are available only using GitHub Packages - the GitHub Container registry. You must use version 2.5.8 or later of the CodeQL CLI to use the CodeQL package manager.
171+
.. include:: ../reusables/beta-note-package-manager.rst
180172

181173
You can use CodeQL query packs in your Code Scanning setup. This allows you to select query packs published by various sources and use them to analyze your code.
182174
For more information, see "`Using CodeQL query packs in the CodeQL action <https://docs.github.com/en/code-security/secure-coding/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-codeql-query-packs/>`_" or "`Downloading and using CodeQL query packs in your CI system <https://docs.github.com/en/code-security/secure-coding/using-codeql-code-scanning-with-your-existing-ci-system/configuring-codeql-cli-in-your-ci-system#downloading-and-using-codeql-query-packs>`_."

docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,7 @@ Creating and working with CodeQL packs
55

66
You can use CodeQL packs to create, share, depend on, and run CodeQL queries and libraries.
77

8-
.. pull-quote::
9-
10-
Note
11-
12-
The CodeQL package manager is currently in beta and subject to change. During the beta, CodeQL packs are available only using GitHub Packages - the GitHub Container registry. You must use version 2.5.8 or later of the CodeQL CLI to use the CodeQL package manager.
8+
.. include:: ../reusables/beta-note-package-manager.rst
139

1410
About CodeQL packs and the CodeQL CLI package manager
1511
-----------------------------------------------------

docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,7 @@ Publishing and using CodeQL packs
55

66
You can publish your own CodeQL packs and use packs published by other people.
77

8-
.. pull-quote::
9-
10-
Note
11-
12-
The CodeQL package manager is currently in beta and subject to change. During the beta, CodeQL packs are available only using GitHub Packages - the GitHub Container registry. You must use version 2.5.8 or later of the CodeQL CLI to use the CodeQL package manager.
8+
.. include:: ../reusables/beta-note-package-manager.rst
139

1410
Configuring the ``qlpack.yml`` file before publishing
1511
-----------------------------------------------------

docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,7 @@ For more information about these metadata properties, see ":ref:`Metadata for Co
5252
Packaging custom QL queries
5353
---------------------------
5454

55-
.. pull-quote::
56-
57-
Note
58-
59-
The CodeQL package manager is currently in beta and subject to change. During the beta, CodeQL packs are available only using GitHub Packages - the GitHub Container registry. You must use version 2.5.8 or later of the CodeQL CLI to use the CodeQL package manager.
60-
55+
.. include:: ../reusables/beta-note-package-manager.rst
6156

6257
When you write your own queries, you should save them in a custom QL pack
6358
directory. When you are ready to share your queries with other users, you can publish the pack as a CodeQL pack to GitHub Packages - the GitHub Container registry.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. pull-quote::
2+
3+
Note
4+
5+
The CodeQL package manager is currently in beta and subject to change. During the beta, CodeQL packs are available only using GitHub Packages - the GitHub Container registry. You must use version 2.6.0 or later of the CodeQL CLI to use the CodeQL package manager.

0 commit comments

Comments
 (0)