GitHub 업로드-결과

GitHub 코드 검사에 SARIF 파일을 업로드합니다.

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

CodeQL은(는) 다음 리포지토리 유형에 사용할 수 있습니다.

이 기사에서

데이터 재사용 코드ql-cli.man-pages-version-note %}

개요

Shell
codeql github upload-results --sarif=<file> [--github-auth-stdin] [--github-url=<url>] [--repository=<repository-name>] [--ref=<ref>] [--commit=<commit>] [--checkout-path=<path>] <options>...

Description

GitHub 코드 검사에 SARIF 파일을 업로드합니다.

          [AUTOTITLE](/code-security/codeql-cli/getting-started-with-the-codeql-cli/uploading-codeql-analysis-results-to-github)을(를) 참조하세요.

GitHub 앱 토큰 또는 개인용 액세스 토큰이 설정되어 있어야 합니다. 최상의 보안을 위해서는 --github-auth-stdin 플래그를 설정하고 표준 입력을 통해 토큰을 명령에 전달하는 것이 좋습니다. 아니면 GITHUB_TOKEN 환경 변수를 설정할 수도 있습니다.

이 토큰에는 security_events 범위가 있어야 합니다.

Options

기본 옵션

-s, --sarif=<file>

          \[필수] 사용할 SARIF 파일의 경로입니다. 이것은 github.com에 업로드하기 위하여 [](/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-analyze)와 함께 실행한 [codeql database analyze](/code-security/reference/code-scanning/codeql/codeql-cli-manual/database-interpret-results)(또는 `--format sarif-latest`)의 출력이거나 GitHub Enterprise Server 인스턴스를 위한 적절한 지원 형식 태그여야 합니다(배포 시 SARIF 버전 지원은 [AUTOTITLE](/enterprise-server@latest/code-security/code-scanning/integrating-with-code-scanning/sarif-support-for-code-scanning)을(를) 참조하세요).

-r, --repository=<repository-name>

업로드용 엔드포인트로 사용할 GitHub 리포지토리 소유자와 이름(예: github/octocat)입니다. 생략하면 CLI가 체크 아웃 경로에서 이를 자동으로 감지하려 할 것입니다.

-f, --ref=<ref>

분석된 ref의 이름입니다. 이 ref가 끌어오기 요청 병합 커밋인 경우, refs/pull/1234/merge 또는 _refs/pull/1234/head_를 사용하세요(끌어오기 요청의 HEAD 커밋에 해당하는지 MERGE 커밋에 해당하는지에 따라 다릅니다). 그렇지 않으면 이것은 분기여야 합니다: refs/heads/branch-name. 생략하면 CLI는 체크 아웃 경로의 현재 분기에서 이 값을 자동으로 채우려고 합니다(존재하는 경우).

-c, --commit=<commit>

분석된 커밋의 SHA입니다. 이것을 생략하면 CLI가 체크 아웃 경로에서 이것을 자동으로 감지하려고 합니다.

-p, --checkout-path=<path>

체크아웃 경로입니다. 기본값은 현재 작업 중인 디렉터리입니다.

--merge

          \[고급] 둘 이상의 SARIF 파일을 지정하도록 허용하고, 업로드 전에 이를 하나의 파일로 병합합니다. 이것은 이전 버전과의 호환성을 위해서만 권장됩니다. 신규 분석의 경우 서로 다른 범주를 가진 별도의 SARIF 파일 두 개를 업로드하는 것이 좋습니다. 이 옵션은 SARIF 버전 2.1.0(이는 CodeQL에서 사용하는 SARIF의 기본 버전입니다)을 사용하여 CodeQL에서 생성한 SARIF 파일과 함께 사용할 때만 작동합니다.

--no-wait-for-processing

기본 설정에 따라, CLI는 GitHub가 SARIF 파일을 처리할 때까지 최대 2분 동안 대기하며, 분석 결과 처리 중에 오류가 발생하면 0이 아닌 종료 코드를 반환합니다. 사용자는 CLI의 대기 시간을 --wait-for-processing-timeout으로 사용자 지정하거나, --no-wait-for-processing으로 이 기능을 비활성화할 수 있습니다.

--wait-for-processing-timeout=<waitForProcessingTimeout>

업로드된 SARIF 파일이 GitHub에서 처리될 때까지 CLI가 대기하는 최대 시간(초 단위)입니다. 기본값은 120초(2분)입니다. 이 옵션은 --wait-for-processing이 활성화된 경우에만 유효합니다.

--format=<fmt>

출력 서식을 선택합니다. 옵션 포함 사항:

          `text`
          _(기본값)_: SARIF 업로드 상태를 추적할 수 있는 URL을 출력합니다.

          `json`: SARIF 업로드 API 요청의 응답 본문을 출력합니다.

          [AUTOTITLE](/rest/code-scanning/code-scanning)도 참조하세요.

SARIF 파일을 업로드할 위치를 구성하는 옵션입니다.

-a, --github-auth-stdin

GitHub 앱 토큰 또는 표준 입력을 통한 개인용 액세스 토큰을 허용합니다.

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

-g, --github-url=<url>

사용할 GitHub 인스턴스의 URL입니다. 생략된 경우 CLI는 체크 아웃 경로에서 자동 검색을 시도하며, 이것이 불가능하면 https://github.com/이 기본적으로 사용됩니다.

일반 옵션

-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`부터 사용할 수 있습니다.