팩 게시

개요

codeql pack publish [--dry-run] [--threads=<num>] [--ram=<MB>] [--pack=<folder> | <package.tgz>] <options>... -- <dir>

codeql pack publish [--dry-run] [--threads=<num>] [--ram=<MB>] [--pack=<folder> | <package.tgz>] <options>... -- <dir>

설명

QL 라이브러리 팩을 패키지 레지스트리에 게시합니다.

이 명령은 패키지 레지스트리에 팩을 게시합니다. 게시하기 전에 먼저 팩이 컴파일되고(필요한 경우) 번들로 묶습니다.

v2.6.0부터 사용할 수 있습니다.

옵션

기본 옵션

<dir>

패키지 또는 작업 영역의 루트 디렉터리로, 기본값은 현재 작업 디렉터리입니다. 이 매개 변수가 qlpack.yml이 포함된 디렉터리를 가리키는 경우 이 작업은 해당 CodeQL 패키지에서만 실행됩니다. 이 매개 변수가 codeql-workspace.yml이 포함된 디렉터리를 가리키는 경우 이 작업은 작업 영역의 모든 CodeQL 패키지에서 실행됩니다.

-n, --[no-]dry-run

수행된 작업을 출력하지만 실제로 패키지를 게시하지는 않습니다.

--no-keep

게시한 후 팩 번들을 삭제합니다.

-j, --threads=<num>

해당 스레드 수를 사용하여 쿼리를 컴파일합니다.

기본값은 1입니다. 0을 전달하여 컴퓨터의 코어당 하나의 스레드를 사용하거나 -_N_을 전달하여 _N_개의 코어를 사용하지 않은 상태로 둘 수 있습니다(하나 이상의 스레드를 계속 사용하는 경우 제외).

-M, --ram=<MB>

컴파일러가 사용할 수 있는 총 RAM 양을 설정합니다.

--no-precompile

[고급] 팩 출력 디렉터리에서 컴파일 캐시를 미리 컴파일하지 않습니다. 이렇게 하면 팩의 크기와 팩을 만드는 데 걸리는 시간이 줄어들지만 팩을 실행하려면 컴파일이 필요합니다. 쿼리 팩에만 의미가 있습니다.

--no-validate-extensions

[고급] 컴파일 단계의 일부로 데이터 확장 프로그램의 유효성을 검사하지 않습니다.

v2.13.3부터 사용할 수 있습니다.

--no-overwrite

[고급] 이 명령의 이전 호출에서 컴파일된 기존 출력을 다시 컴파일하고 덮어쓰지 않도록 합니다.

-p, --pack=<folder> | <package.tgz>

[고급] 패키지된 tarball을 배치할 위치입니다. 이 옵션이 .tgz로 끝나면 해당 이름으로 tarball이 만들어집니다. 그렇지 않으면 지정된 경로에 새 디렉터리가 만들어지고 거기에 하나 이상의 tarball이 만들어집니다. 작업 영역에는 .tgz를 사용할 수 없습니다.

--file=<package.tgz>

[고급] 새로 만들거나 번들로 묶지 않고 package.tgz를 패키지 레지스트리에 직접 업로드합니다.

--[no-]allow-prerelease

시험판 버전 한정자가 있는 팩(예: X.Y.Z-qualifier) 사용을 허용합니다. 이 플래그가 없으면 시험판 팩은 무시됩니다.

v2.11.3부터 사용할 수 있습니다.

이 명령을 적용할 CodeQL 팩을 구성하는 옵션

--format=<fmt>

출력 형식(text(기본값) 또는 json)을 선택합니다.

--groups=[-]<group>[,[-]<group>...]

이 작업에서 포함하거나 제외할 CodeQL 팩 그룹 목록입니다. 다음과 같은 경우 지정된 작업 영역의 qlpack이 포함됩니다.

• 빼기 기호 없이 나열된 그룹 중 하나 이상에 속하는 경우(빼기 기호 없이 나열된 그룹이 없으면 이 조건이 자동으로 충족됨) 및
• 빼기 기호로 나열된 그룹에 속하지 않는 경우

컴파일 환경을 설정하는 옵션

--search-path=<dir>[:<dir>...]

QL 팩을 찾을 수 있는 디렉터리 목록입니다. 각 디렉터리는 QL 팩(또는 루트에 .codeqlmanifest.json 파일이 포함된 팩 번들) 또는 그러한 디렉터리 하나 이상의 직계 부모일 수 있습니다.

경로에 둘 이상의 디렉터리가 포함된 경우 디렉터리의 순서가 우선 순위를 정의합니다. 확인해야 하는 팩 이름이 디렉터리 트리 중 둘 이상에서 일치하는 경우 먼저 지정된 디렉터리가 우선합니다.

오픈 소스 CodeQL 리포지토리의 체크 아웃에서 이를 가리키면 해당 리포지토리에 있는 언어 중 하나를 쿼리할 때 작동해야 합니다.

압축을 푼 CodeQL 툴체인의 형제로 CodeQL 리포지토리를 체크 아웃한 경우 이 옵션을 지정할 필요가 없습니다. 이러한 형제 디렉터리는 다른 방법으로는 찾을 수 없는 QL 팩으로 항상 검색됩니다. (이 기본값이 작동하지 않는 경우 사용자별 구성 파일에서 --search-path를 한 번만 설정하는 것이 좋습니다).

(참고: Windows에서는 경로 구분 기호가 ;입니다.)

--additional-packs=<dir>[:<dir>...]

이 디렉터리 목록이 지정된 경우 --search-path에 있는 디렉터리보다 먼저 팩이 검색됩니다. 이 사이의 순서는 중요하지 않습니다. 이 목록을 통해 서로 다른 두 위치에서 팩 이름을 찾을 경우 오류가 발생합니다.

이 기능은 기본 경로에도 표시되는 팩의 새 버전을 일시적으로 개발하는 경우에 유용합니다. 반면에 구성 파일에서 이 옵션을 재정의하는 것은 권장되지 않습니다. 일부 내부 작업에서는 구성된 값을 재정의하여 즉시 이 옵션을 추가합니다.

(참고: Windows에서는 경로 구분 기호가 ;입니다.)

--library-path=<dir>[:<dir>...]

[고급] QL 라이브러리의 원시 가져오기 검색 경로에 추가될 선택적 디렉터리 목록입니다. QL 팩으로 패키지되지 않은 QL 라이브러리를 사용하려는 경우에만 사용해야 합니다.

(참고: Windows에서는 경로 구분 기호가 ;입니다.)

--dbscheme=<file>

[고급] 컴파일해야 하는 dbscheme 쿼리를 명시적으로 정의합니다. 자신이 수행하고 있는 작업에 대해 매우 확신하는 호출자에 의해서만 지정되어야 합니다.

--compilation-cache=<dir>

[고급] 컴파일 캐시로 사용할 추가 디렉터리를 지정합니다.

--no-default-compilation-cache

[고급] 쿼리를 포함하는 QL 팩 또는 CodeQL 툴체인 디렉터리와 같은 표준 위치에서 컴파일 캐시를 사용하지 않습니다.

CodeQL 패키지 관리자를 구성하는 옵션

--registries-auth-stdin

쉼표로 구분된 <registry_url>=<token> 쌍 목록을 전달하여 GitHub Enterprise Server 컨테이너 레지스트리에 인증합니다.

예를 들어 https://containers.GHEHOSTNAME1/v2/=TOKEN1,https://containers.GHEHOSTNAME2/v2/=TOKEN2를 전달하여 두 개의 GitHub Enterprise Server 인스턴스에 인증할 수 있습니다.

이렇게 하면 CODEQL_REGISTRIES_AUTH 및 GITHUB_TOKEN 환경 변수가 재정의됩니다. github.com 컨테이너 레지스트리에만 인증해야 하는 경우 더 간단한 --github-auth-stdin 옵션을 사용하여 인증할 수 있습니다.

--github-auth-stdin

표준 입력을 통해 github.com에 GitHub Apps 토큰 또는 개인용 액세스 토큰을 전달하여 github.com 컨테이너 레지스트리에 인증합니다.

GitHub Enterprise Server 컨테이너 레지스트리에 인증하려면 --registries-auth-stdin을 전달하거나 CODEQL_REGISTRIES_AUTH 환경 변수를 사용합니다.

이렇게 하면 GITHUB_TOKEN 환경 변수가 재정의됩니다.

일반 옵션

-h, --help

이 도움말 텍스트를 표시합니다.

-J=<opt>

[고급] 명령을 실행하는 JVM에 옵션을 지정합니다.

(공백을 포함하는 옵션은 올바르게 처리되지 않을 수 있으니 주의하세요.)

-v, --verbose

출력되는 진행률 메시지 수를 점진적으로 늘립니다.

-q, --quiet

출력되는 진행률 메시지 수를 점진적으로 줄입니다.

--verbosity=<level>

[고급] 세부 정보 표시 수준을 오류, 경고, 진행률, 진행률+, 진행률++, 진행률+++ 중 하나로 명시적으로 설정합니다. -v 및 -q를 재정의합니다.

--logdir=<dir>

[고급] 타임스탬프와 실행 중인 하위 명령의 이름을 포함하는 생성된 이름을 사용하여 지정된 디렉터리에 있는 하나 이상의 파일에 자세한 로그를 기록합니다.

(모든 권한을 가진 이름으로 로그 파일을 작성하려면 --log-to-stderr을(를) 지정하고 stderr를 원하는 대로 리디렉션합니다.)

--common-caches=<dir>

[고급] 다운로드한 QL 팩 및 컴파일된 쿼리 계획과 같이 여러 CLI 실행 간에 유지되는 디스크의 캐시된 데이터의 위치를 제어합니다. 명시적으로 설정하지 않은 경우 이 기본값은 사용자의 홈 디렉터리에 이름이 지정된 .codeql 디렉터리로 설정되며, 아직 없는 경우 만들어집니다.

v2.15.2부터 사용할 수 있습니다.