github upload-results

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

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

개요

Shell

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

설명

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

https://docs.github.com/en/code-security/secure-coding/running-codeql-cli-in-your-ci-system#uploading-results-to-github을 참조하세요.

GitHub 앱 토큰 또는 개인용 액세스 토큰을 설정해야 합니다. 모범 보안 사례의 경우 플래그를 설정하고 표준 입력을 --github-auth-stdin 통해 명령에 토큰을 전달하는 것이 좋습니다. 또는 환경 변수를 GITHUB_TOKEN 설정할 수 있습니다.

이 토큰에는 security_events scope 있어야 합니다.

기본 옵션

`-s, --sarif=<file>`

[필수] 업로드할 SARIF 파일의 경로입니다. 이는 github.com 또는 GitHub AE에 업로드하기 위해 를 사용하여 codeql 데이터베이스 분석 (또는 codeql 데이터베이스 해석 결과) --format sarif-latest 의 출력이거나 GitHub Enterprise Server 인스턴스에 대해 지원되는 적절한 형식 태그(릴리스에 적합한 값 참조 https://docs.github.com/ )여야 합니다.

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

업로드를 위한 엔드포인트로 사용할 GitHub 리포지토리 소유자 및 이름(예: github/octocat)입니다. CLI는 생략된 경우 체크 아웃 경로에서 이를 자동으로 검색하려고 시도합니다.

`-f, --ref=<ref>`

분석된 ref의 이름입니다. 이 ref가 끌어오기 요청 병합 커밋인 경우 refs/pulls/1234/merge 또는 refs/pulls/1234/head를 사용합니다(이 커밋이 PR의 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의 기본 버전임).