From de5d14df62c41e39d4fdcb5c500d156ece977abc Mon Sep 17 00:00:00 2001 From: Felicity Chapman Date: Mon, 26 Jul 2021 23:37:13 +0100 Subject: [PATCH] Replace package manager --- docs/codeql/codeql-cli/about-codeql-packs.rst | 2 +- .../creating-and-working-with-codeql-packs.rst | 10 +++++----- docs/codeql/reusables/beta-note-package-manager.rst | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/docs/codeql/codeql-cli/about-codeql-packs.rst b/docs/codeql/codeql-cli/about-codeql-packs.rst index b6f7b0fe742..278e123a1de 100644 --- a/docs/codeql/codeql-cli/about-codeql-packs.rst +++ b/docs/codeql/codeql-cli/about-codeql-packs.rst @@ -12,7 +12,7 @@ There are two types of CodeQL packs: query packs and library packs. * Query packs are designed to be run. When a query pack is published, the bundle includes all the transitive dependencies and a compilation cache. This ensures consistent and efficient execution of the queries in the pack. * Library packs are designed to be used by query packs (or other library packs) and do not contain queries themselves. The libraries are not compiled and there is no compilation cache included when the pack is published. -You can use the CodeQL package manger in the CodeQL CLI to create CodeQL packs, add dependencies to packs, and install or update dependencies. For more information, see ":ref:`Creating and working with CodeQL packs `." You can also publish and download CodeQL packs using the CodeQL package manager. For more information, see ":doc:`Publishing and using CodeQL packs `." +You can use the package management commands in the CodeQL CLI to create CodeQL packs, add dependencies to packs, and install or update dependencies. For more information, see ":ref:`Creating and working with CodeQL packs `." You can also publish and download CodeQL packs using the CodeQL CLI. For more information, see ":doc:`Publishing and using CodeQL packs `." CodeQL pack structure --------------------- 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 beb1f9f8e0e..0f762c0e9d0 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 @@ -7,20 +7,20 @@ You can use CodeQL packs to create, share, depend on, and run CodeQL queries and .. include:: ../reusables/beta-note-package-manager.rst -About CodeQL packs and the CodeQL CLI package manager ------------------------------------------------------ +About CodeQL packs and the CodeQL CLI +------------------------------------- -With CodeQL packs and the CodeQL CLI package manager, you can publish your custom queries and integrate them into your codebase analysis. +With CodeQL packs and the package management commands in the CodeQL CLI, you can publish your custom queries and integrate them into your codebase analysis. There are two types of CodeQL packs: query packs and library packs. * Query packs are designed to be run. When a query pack is published, the bundle includes all the transitive dependencies and a compilation cache. This ensures consistent and efficient execution of the queries in the pack. * Library packs are designed to be used by query packs (or other library packs) and do not contain queries themselves. The libraries are not compiled and there is no compilation cache included when the pack is published. -You can use the CodeQL package manger in the CodeQL CLI to create CodeQL packs, add dependencies to packs, and install or update dependencies. You can also publish and download CodeQL packs using the CodeQL package manager. For more information, see ":doc:`Publishing and using CodeQL packs `." +You can use the ``pack`` command in the CodeQL CLI to create CodeQL packs, add dependencies to packs, and install or update dependencies. You can also publish and download CodeQL packs using the ``pack`` command. For more information, see ":doc:`Publishing and using CodeQL packs `." Creating a CodeQL pack ----------------------------- +---------------------- You can create a CodeQL pack by running the following command from the checkout root of your project: :: diff --git a/docs/codeql/reusables/beta-note-package-manager.rst b/docs/codeql/reusables/beta-note-package-manager.rst index 19169a328ff..413bf80e610 100644 --- a/docs/codeql/reusables/beta-note-package-manager.rst +++ b/docs/codeql/reusables/beta-note-package-manager.rst @@ -2,4 +2,4 @@ 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.6.0 or later of the CodeQL CLI to use the CodeQL package manager. \ No newline at end of file + 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