코드 검사에 대한 기본 설정 구성

기본 설정 정보

code scanning의 기본 설정은 리포지토리에서 code scanning을(를) 활성화하는 가장 빠르고 쉽고 유지 관리 부담이 가장 적은 방법입니다. 리포지토리의 코드를 기반으로 기본 설정은 사용자 지정 code scanning 구성을 자동으로 만듭니다. 기본 설정을 활성화한 후, 리포지토리에서 CodeQL이(가) 지원하는 언어로 작성된 코드가 검사됩니다:

리포지토리의 기본 분기 또는 보호된 모든 분기에 대한 각 푸시 시. 보호된 분기에 대한 자세한 내용은 보호된 분기 정보을(를) 참조하세요.
포크의 끌어오기 요청을 제외하고, 리포지토리의 기본 분기 또는 보호된 모든 분기를 대상으로 하는 끌어오기 요청을 만들거나 커밋할 때.
매주 일정으로.

참고

기본 설정이 6개월 동안 활성화됨으로 설정된 리포지토리에서 푸시 및 끌어오기 요청이 발생하지 않으면, GitHub Actions 분을 절약하기 위해 주간 일정이 비활성화됨으로 설정됩니다.

또한 조직의 여러 리포지토리 또는 모든 리포지토리에 대해 동시에 기본 설정을 활성화할 수 있습니다. 대량 활성화에 대한 자세한 내용은 대규모 코드 검사를 위한 기본 설정 구성을(를) 참조하세요.

code scanning 구성에 대해 더 세밀한 제어가 필요하면 대신 고급 설정을 구성해야 합니다. 자세한 내용은 코드 검사에 대한 고급 설정 구성을(를) 참조하세요.

기본 설정 사용 요구 사항

다음 조건을 충족하면 리포지토리는 code scanning의 기본 설정을 사용할 수 있습니다:

GitHub Actions이(가) 가동되었습니다.
GitHub Advanced Security가 사용됩니다.

나중에 리포지토리에 하나 이상의 CodeQL 지원 언어가 포함될 가능성이 있는 경우 적격 리포지토리에 대한 기본 설정을 사용하도록 설정하는 것이 좋습니다. CodeQL 지원 언어를 포함하지 않는 리포지토리에서 기본 설정을 사용하면 기본 설정에서 검사를 실행하거나 GitHub Actions분을 사용하지 않습니다. CodeQL 지원 언어가 리포지토리의 기본 분기에 추가되면 기본 설정에서 자동으로 CodeQL 지원 언어를 검사하고 GitHub Actions분을 사용하기 시작합니다. CodeQL 지원 언어에 대한 자세한 정보는 CodeQL을 사용하는 코드 검사 안내을(를) 참조하세요.

자체 호스팅 실행기 또는 GitHub 호스팅 실행기에서 CodeQL 지원 언어 모두에 대해 기본 설정을 사용할 수 있습니다. 이 문서의 뒷부분에 있는 실행기에 레이블 할당을 참조하세요.

기본 설정은 C# 및 Java에 대해 none 빌드 모드를 사용하고, 다른 컴파일된 언어에 대해서는 autobuild 빌드 모드를 사용합니다. C/C++, C# 및 Swift 분석에 필요한 모든 명령을 실행할 수 있도록 자체 호스팅 실행기를 구성해야 합니다. JavaScript/TypeScript, Go, Ruby, Python 및 Kotlin 코드 분석에는 현재 특별한 구성이 필요하지 않습니다.

기본 설정 사용자 지정

code scanning은(는) 기본 설정으로 시작하는 것을 권장합니다. 처음 기본 설정을 구성한 후에는, code scanning이(가) 어떻게 작동하는지 평가할 수 있습니다. 예상대로 작동하지 않는 항목이 있으면, 요구 사항을 더 잘 충족하도록 기본 설정을 사용자 지정할 수 있습니다. 자세한 내용은 코드 검색을 위한 기본 설정 평가을(를) 참조하세요.

기본 설정에 새 언어 추가 정보

리포지토리의 코드가 CodeQL 지원 언어를 포함하도록 변경되면, GitHub은(는) 새 언어를 포함하도록 code scanning 구성을 자동으로 업데이트합니다. code scanning이(가) 새 구성에서 실패하면, 리포지토리에서 code scanning 커버리지가 손실되지 않도록 GitHub이(가) 이전 구성을 자동으로 다시 사용합니다.

리포지토리에 대한 기본 설정 구성

참고

리포지토리에서 CodeQL 지원 언어 모두에 대해 분석이 실패하더라도 기본 설정은 계속 활성화됨이지만, 다른 CodeQL 지원 언어가 리포지토리에 추가되거나 기본 설정이 수동으로 다시 구성되고 CodeQL 지원 언어의 분석이 성공할 때까지는 검사를 실행하지 않으며 GitHub Actions 분도 사용하지 않습니다.

GitHub에서 리포지토리의 기본 페이지로 이동합니다.

참고

포크에서 기본 설정을 구성하는 경우 먼저 GitHub Actions을(를) 활성화해야 합니다. GitHub Actions을(를) 활성화하려면 리포지토리 이름 아래에서 작업을 클릭한 다음 워크플로를 이해했으므로 계속 진행하여 활성화합니다를 클릭하세요. 이렇게 하면 포크의 기존 워크플로가 모두 활성화됩니다.
리포지토리 이름 아래에서 Settings를 클릭합니다. "설정" 탭이 표시되지 않으면 드롭다운 메뉴를 선택한 다음 설정을 클릭합니다.
사이드바의 "Security" 섹션에서 Code security 를 클릭합니다.
"Code scanning" 섹션에서 Set up을 선택한 다음, Default를 클릭합니다.

그런 다음 기본 설정에서 자동으로 생성된 code scanning 구성을 요약하는 “CodeQL 기본 구성” 대화 상자가 표시됩니다.
선택적으로 code scanning 설정을 사용자 지정하려면 편집을 클릭하세요.
- 기본 설정에서 수행되는 분석에 언어를 추가하거나 제거하려면 “언어” 섹션에서 해당 언어를 선택하거나 선택을 취소하세요.
- 사용하려는 CodeQL 쿼리 도구 모음을 지정하려면 “쿼리 도구 모음” 섹션에서 선호하는 쿼리 도구 모음을 선택하세요.
리포지토리에서 기본 설정에 대한 설정을 검토한 다음 CodeQL 활성화를 클릭하세요. 이렇게 하면 새로 자동 생성된 구성을 테스트하는 워크플로가 트리거됩니다.

참고

고급 설정에서 기본 설정으로 전환하는 경우, 기본 설정이 기존 code scanning 구성을 재정의한다는 경고가 표시됩니다. 이 경고는 기본 설정이 기존 워크플로 파일을 비활성화하고 CodeQL 분석 API 업로드를 모두 차단함을 의미합니다.
선택적으로 활성화 후 기본 설정 구성을 보려면 을 선택한 다음 CodeQL 구성 보기를 클릭하세요.

실행기에 레이블 할당

참고

Code scanning은(는) 기본 설정이 활성화된 경우 할당된 실행기를 확인합니다. 기본 설정을 이미 실행 중인 리포지토리에 실행기가 할당되면, 실행기 사용을 시작하려면 기본 설정을 비활성화한 다음 다시 활성화해야 합니다. 실행기를 추가하고 이를 사용하기 시작하려면, 기본 설정을 비활성화하고 다시 활성화할 필요 없이 구성을 수동으로 변경할 수 있습니다.

또한 자체 호스팅 실행기에 기본 code-scanning 레이블을 할당할 수 있으며, 또는 필요에 따라 사용자 지정 레이블을 지정하여 개별 리포지토리에서 서로 다른 실행기를 사용할 수 있습니다. 자체 호스팅 실행기에 레이블을 할당하는 방법에 대한 자세한 내용은 자체 호스트형 실행기로 레이블 사용을(를) 참조하세요.

다음 단계

구성이 최소 1회 성공적으로 실행된 후에는 code scanning 경고를 검토하고 해결하기 시작할 수 있습니다. code scanning 경고에 대한 자세한 내용은 코드 검사 경고 정보 및 리포지토리에 대한 코드 검사 경고 평가를 참조하세요.

code scanning에 대해 기본 설정을 구성한 후에는, 사용자에게 어떻게 작동하는지 평가하는 방법과 이를 사용자 지정하기 위해 취할 수 있는 다음 단계에 대해 확인할 수 있습니다. 자세한 내용은 코드 검색을 위한 기본 설정 평가을(를) 참조하세요.

각 검사의 타임스탬프와 검사된 파일의 백분율을 포함하여 code scanning 구성에 대한 자세한 정보는 도구 상태 페이지에서 확인할 수 있습니다. 자세한 내용은 코드 검색에 도구 상태 페이지 사용을(를) 참조하세요.

기본 설정을 구성할 때 오류가 발생할 수 있습니다. 특정 오류 문제 해결에 대한 자세한 내용은 코드 검사 분석 오류 문제 해결을(를) 참조하세요.

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

이 기사에서