에 대한 리포지토리 속성 code scanning

사전 요구 사항

여기에 설명된 리포지토리 속성이 효과를 발휘하려면 설정 code scanning해야 합니다. 코드 검색을 위한 설정 유형 정보을(를) 참조하세요.

영향을 code scanning 미치는 리포지토리 속성은 조직에 대해 수동으로 만들어야 합니다. 그런 다음 전체 조직에 적용되는 값을 설정하거나 각 리포지토리에 대해 다르게 구성할 수 있습니다. 조직의 리포지토리에 대한 사용자 지정 속성 관리을(를) 참조하세요.

변경 내용을 적용하기 전에 테스트

리포지토리 속성을 통해 적용된 구성이 전체 조직에 배포하기 전에 원하는 효과가 있는지 테스트할 수 있습니다. 리포지토리 속성은 개별 리포지토리에 대한 특정 값으로 설정할 수 있습니다. 처음으로 리포지토리 속성을 구성하는 경우 조직에 맞게 리포지토리 속성을 만들지만 값으로 설정하지는 않습니다. 대신 변경 내용의 유효성을 먼저 검사할 수 있는 특정 테스트 리포지토리의 값으로 설정합니다. 테스트 리포지토리에서 유효성을 검사한 후에는 전체 조직 또는 원하는 리포지토리에 대한 값을 설정할 수 있습니다.

지원되는 리포지토리 속성의 값을 변경하는 경우 동일한 방법을 사용할 수 있습니다. 테스트 리포지토리의 리포지토리 속성 값을 재정의하거나 설정하고, 변경 내용의 유효성을 검사한 다음, 조직 또는 다른 리포지토리에 롤아웃합니다.

에 대해 지원되는 리포지토리 속성 code scanning

리포지토리 속성을 사용하여 일부 code scanning 기능을 구성할 수 있습니다. 조직은 리포지토리 속성을 사용하여 모든 리포지토리 및 개별 리포지토리에 구성을 적용할 수 있습니다. 리포지토리 속성을 사용하여 사용자 지정하는 경우 code scanning 사용자 지정은 모든 설치 유형에 적용됩니다.

다음은 구성할 때 분석에 영향을 code scanning 주는 설정할 수 있는 리포지토리 속성에 대한 개요입니다.

이름	유형
github-codeql-config-file	텍스트
github-codeql-extra-queries	텍스트
github-codeql-disable-overlay	True/false
github-codeql-file-coverage-on-prs	True/false
github-codeql-tools	텍스트

사용자 지정 구성 파일

구성 파일의 github-codeql-config-file 로컬 또는 원격 경로로 속성을 설정할 수 있습니다. 이 속성에 허용되는 값은 작업의 매개 변수 codeql-action/init 와 config-file 동일합니다. 허용되는 경로 형식 및 구성 파일의 가능한 내용에 대한 자세한 내용은 코드 검색을 위한 워크플로 구성 옵션을 참조하세요.

속성에 지정된 값은 github-codeql-config-file 기본 설정 및 code scanning 고급 설정 모두 code scanning 에 적용됩니다. 고급 설치 워크플로가 작업의 매개 변수 codeql-action/init 에 대한 config-file 명시적 입력을 지정하는 경우 해당 입력이 리포지토리 속성에 구성된 값보다 우선합니다. 이렇게 하면 원하는 경우 고급 워크플로에서 기본 설정 워크플로에 적용된 구성과 다른 구성을 사용할 수 있습니다.

속성을 사용하여 적용된 github-codeql-config-file 사용자 지정 구성 파일은 기본 설정이 code scanning 자동으로 생성하는 구성과 병합됩니다. Code scanning 기본 설정을 사용하면 사용할 위협 모델 또는 CodeQL 모델 팩과 같은 사용자 인터페이스의 일부 분석 설정을 사용자 지정할 수 있습니다. 이러한 선택은 병합된 구성에 유지됩니다. 기본 설정 UI에서 선택한 위협 모델은 구성 파일에 지정된 위협 모델과 결합되고 UI에 구성된 모델 팩은 유지됩니다. 기본 설정에서 사용 가능한 구성 옵션에 대한 자세한 내용은 코드 검색을 위한 설정 유형 정보 을 code scanning 참조하세요.

기타 분석 사용자 지정

이 github-codeql-extra-queries 속성을 사용하면 실행해야 하는 추가 쿼리를 구성할 수 있습니다. 이는 개별 워크플로를 수정하거나 고급 설정으로 전환할 필요 없이 조직의 모든 관련 분석에 쿼리를 추가하는 데 유용합니다. queries의 입력과 동일한 값을 받습니다. 코드 검색을 위한 워크플로 구성 옵션을(를) 참조하세요.

기본적으로 code scanning 분석은 최신 릴리스 버전의 CodeQL을 사용합니다. 일반적으로 다른 버전으로 전환하여 해결되는 특정 문제가 발생하지 않는 한 이를 변경하는 것이 좋습니다. 이를 github-codeql-tools 변경해야 하는 경우 속성을 사용하여 다른 버전을 지정할 수 있습니다.

고급 설치 워크플로가 작업의 매개 변수 codeql-action/init 에 대한 tools 명시적 입력을 지정하는 경우 해당 입력이 리포지토리 속성에 구성된 값보다 우선합니다. 이렇게 하면 원하는 경우 고급 워크플로에서 기본 설정 워크플로에 적용된 구성과 다른 구성을 사용할 수 있습니다. 명시적 tools 입력이 있더라도 고급 설정 워크플로에 리포지토리 속성 값을 적용하려면 리포지토리 속성 값에 접두사를 추가 ! 합니다. 예를 들어 !nightly 모든 워크플로에서 최신 nightly 릴리스를 사용하도록 적용합니다.

기능 사용 또는 사용 안 함

속성을 github-codeql-disable-overlay로 설정하여 향상된 증분 분석을 사용하지 않도록 할 수 있습니다. 이는 향상된 하드웨어 요구 사항으로 인해 향상된 증분 분석이 실패하는 경우에 유용할 수 있습니다.

끌어오기 요청 분석에 대한 파일 커버리지 정보는 계산되지 않습니다. 끌어오기 요청에 대해 파일 커버리지 정보를 사용하려면 github-codeql-file-coverage-on-prs 속성을 true로 설정할 수 있습니다.