팩 게시

참고 항목

이 콘텐츠는 CodeQL CLI의 최신 릴리스에 대해 설명합니다. 이 요소에 대한 자세한 내용은 http://github.com/github/codeql-cli-binaries/releases을(를) 참조하세요.

이전 릴리스에서 이 명령에 사용할 수 있는 옵션의 세부 정보를 보려면 터미널에서 옵션을 사용하여 --help 명령을 실행합니다.

개요

Shell

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>

Description

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

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

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

Options

기본 옵션

`<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`

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

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

이는 CODEQL_REGISTRIES_AUTH 및 GITHUB_TOKEN 환경 변수를 재정의합니다. GitHub 컨테이너 레지스트리에 인증만 필요한 경우 --github-auth-stdin 옵션을 사용하여 간편하게 인증할 수 있습니다.

`--github-auth-stdin`

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

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

이는 GITHUB_TOKEN 환경 변수를 재정의합니다.

          \[고급] 명령을 실행하는 JVM에 옵션을 전달합니다.

(공백이 포함된 옵션은 올바르게 처리되지 않을 수 있습니다.)

          \[고급] 상세 수준을 명시적으로 설정합니다. 선택 가능한 값: errors, warnings, progress, progress+, progress++, progress+++. 
          `-v` 및 `-q`를 재정의합니다.

`--logdir=<dir>`

          \[고급] 지정된 디렉토리에 자세한 로그를 하나 이상 기록합니다. 로그 파일 이름에는 타임스탬프와 실행 중인 하위 명령 이름이 포함됩니다.

(로그 파일 이름을 완전히 제어하고 싶다면, 대신 --log-to-stderr을 사용하고 원하는 대로 stderr를 리디렉션하세요.)

`--common-caches=<dir>`

          \[고급] CLI의 여러 실행 간에 유지되는 디스크상의 캐시 데이터 위치를 제어합니다. 여기에는 다운로드된 QL 팩과 컴파일된 쿼리 계획이 포함됩니다. 명시적으로 설정하지 않은 경우, 사용자 홈 디렉터리에 있는 `.codeql`이라는 이름의 디렉터리를 기본값으로 사용하며, 해당 디렉터리가 존재하지 않으면 새로 생성됩니다.

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

누가 이 기능을 사용할 수 있나요?

이 문서의 내용

개요

Description

Options

기본 옵션

`<dir>`

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

`--no-keep`

`-j, --threads=<num>`

`-M, --ram=<MB>`

`--no-precompile`

`--no-validate-extensions`

`--no-overwrite`

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

`--file=<package.tgz>`

`--[no-]allow-prerelease`

이 명령을 적용할 CodeQL 팩을 구성하는 옵션입니다.

`--format=<fmt>`

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

컴파일 환경 설정 옵션

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

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

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

`--dbscheme=<file>`

`--compilation-cache=<dir>`

`--no-default-compilation-cache`

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

`--registries-auth-stdin`

`--github-auth-stdin`

일반 옵션

`-h, --help`

`-J=<opt>`

`-v, --verbose`

`-q, --quiet`

`--verbosity=<level>`

`--logdir=<dir>`

`--common-caches=<dir>`