From f060296cf81dc1e8ae28ae02d4254fb72351a779 Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Tue, 27 Jul 2021 12:52:15 +0100 Subject: [PATCH] Update beta note with details of release --- docs/codeql/codeql-cli/about-codeql-packs.rst | 2 +- .../codeql-cli/analyzing-databases-with-the-codeql-cli.rst | 4 ++-- .../codeql-cli/creating-and-working-with-codeql-packs.rst | 2 +- docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst | 2 +- .../codeql-cli/using-custom-queries-with-the-codeql-cli.rst | 2 +- docs/codeql/reusables/beta-note-package-management.rst | 5 +++++ docs/codeql/reusables/beta-note-package-manager.rst | 5 ----- 7 files changed, 11 insertions(+), 11 deletions(-) create mode 100644 docs/codeql/reusables/beta-note-package-management.rst delete mode 100644 docs/codeql/reusables/beta-note-package-manager.rst diff --git a/docs/codeql/codeql-cli/about-codeql-packs.rst b/docs/codeql/codeql-cli/about-codeql-packs.rst index 6b464b17275..2f9c6eebd37 100644 --- a/docs/codeql/codeql-cli/about-codeql-packs.rst +++ b/docs/codeql/codeql-cli/about-codeql-packs.rst @@ -3,7 +3,7 @@ About CodeQL packs ================== -.. include:: ../reusables/beta-note-package-manager.rst +.. include:: ../reusables/beta-note-package-management.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. diff --git a/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst index 312715dd176..884eaf69444 100644 --- a/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/analyzing-databases-with-the-codeql-cli.rst @@ -111,7 +111,7 @@ see ":doc:`Using custom queries with the CodeQL CLI `_" or "`Downloading and using CodeQL query packs in your CI system `_." diff --git a/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst b/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst index 0f762c0e9d0..6373440bcbb 100644 --- a/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst +++ b/docs/codeql/codeql-cli/creating-and-working-with-codeql-packs.rst @@ -5,7 +5,7 @@ Creating and working with CodeQL packs You can use CodeQL packs to create, share, depend on, and run CodeQL queries and libraries. -.. include:: ../reusables/beta-note-package-manager.rst +.. include:: ../reusables/beta-note-package-management.rst About CodeQL packs and the CodeQL CLI ------------------------------------- diff --git a/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst b/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst index d7255124eb6..b3c24016eea 100644 --- a/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst +++ b/docs/codeql/codeql-cli/publishing-and-using-codeql-packs.rst @@ -5,7 +5,7 @@ Publishing and using CodeQL packs You can publish your own CodeQL packs and use packs published by other people. -.. include:: ../reusables/beta-note-package-manager.rst +.. include:: ../reusables/beta-note-package-management.rst Configuring the ``qlpack.yml`` file before publishing ----------------------------------------------------- diff --git a/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst b/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst index 0bafa9cea30..8208cd59a56 100644 --- a/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst +++ b/docs/codeql/codeql-cli/using-custom-queries-with-the-codeql-cli.rst @@ -52,7 +52,7 @@ For more information about these metadata properties, see ":ref:`Metadata for Co Packaging custom QL queries --------------------------- -.. include:: ../reusables/beta-note-package-manager.rst +.. include:: ../reusables/beta-note-package-management.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. diff --git a/docs/codeql/reusables/beta-note-package-management.rst b/docs/codeql/reusables/beta-note-package-management.rst new file mode 100644 index 00000000000..025e89489ab --- /dev/null +++ b/docs/codeql/reusables/beta-note-package-management.rst @@ -0,0 +1,5 @@ +.. pull-quote:: + + Note + + The CodeQL package management functionality, including CodeQL packs, is currently available as a beta release and is subject to change. During the beta release, CodeQL packs are available only using GitHub Packages - the GitHub Container registry. To use this beta functionality, install the beta release of the CodeQL CLI bundle from: https://github.com/github/codeql-action/releases/tag/codeql-bundle-v2.6.0-beta.1. \ No newline at end of file diff --git a/docs/codeql/reusables/beta-note-package-manager.rst b/docs/codeql/reusables/beta-note-package-manager.rst deleted file mode 100644 index 413bf80e610..00000000000 --- a/docs/codeql/reusables/beta-note-package-manager.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. pull-quote:: - - Note - - The CodeQL package management commands are currently in beta and subject to change. During the beta release, 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 package management commands. \ No newline at end of file