hohn/codeql
1
0
Fork 0
mirror of https://github.com/github/codeql.git synced 2026-02-02 16:23:02 +01:00
Code Issues Packages Projects Releases Wiki Activity

Move beta note into a reusable

Browse Source
This commit is contained in:
Felicity Chapman
2021-07-26 23:15:45 +01:00
parent 84fe27270f
commit 5197c2db9f
6 changed files with 11 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/codeql/codeql-cli/about-codeql-packs.rst
View File

@@ -3,11 +3,7 @@
About CodeQL packs
==================
.. pull-quote::
Note
CodeQL packs are currently in beta and subject to change.
.. include:: ../reusables/beta-note-package-manager.rst
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.

12
docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst
View File

@@ -111,11 +111,7 @@ see ":doc:`Using custom queries with the CodeQL CLI <using-custom-queries-with-t
Running a CodeQL pack
~~~~~~~~~~~~~~~~~~~~~
.. pull-quote::
Note
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.
.. include:: ../reusables/beta-note-package-manager.rst
To run an existing CodeQL query pack from the GitHub Container registry, you need to download it first::
@@ -172,11 +168,7 @@ If the analysis found fewer results for standard queries than you expected, revi
Integrating a CodeQL pack into a code scanning workflow in GitHub
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. pull-quote::
Note
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.
.. include:: ../reusables/beta-note-package-manager.rst
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.
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>`_."

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

@@ -5,11 +5,7 @@ Creating and working with CodeQL packs
You can use CodeQL packs to create, share, depend on, and run CodeQL queries and libraries.
.. pull-quote::
Note
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.
.. include:: ../reusables/beta-note-package-manager.rst
About CodeQL packs and the CodeQL CLI package manager
-----------------------------------------------------

6
docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst
View File

@@ -5,11 +5,7 @@ Publishing and using CodeQL packs
You can publish your own CodeQL packs and use packs published by other people.
.. pull-quote::
Note
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.
.. include:: ../reusables/beta-note-package-manager.rst
Configuring the ``qlpack.yml`` file before publishing
-----------------------------------------------------

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

@@ -52,12 +52,7 @@ For more information about these metadata properties, see ":ref:`Metadata for Co
Packaging custom QL queries
---------------------------
.. pull-quote::
Note
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.
.. include:: ../reusables/beta-note-package-manager.rst
When you write your own queries, you should save them in a custom QL pack
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.