Skip to main content

도구 상태 페이지 정보

도구 상태 페이지는 리포지토리에 있는 code scanning 도구의 상태와 성능에 대한 가시성을 제공합니다.

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

쓰기 권한이 있는 사용자

Code scanning은 다음 리포지토리 유형에서 사용할 수 있습니다.

  • GitHub.com에 대한 퍼블릭 리포지토리
  • GitHub Team, GitHub Enterprise Cloud 또는 GitHub Enterprise Server에 대한 조직 소유의 리포지토리로, GitHub Code Security 가 활성화되어 있습니다.

기업에서 코드 스캐닝 사용 설정하기

도구 상태 페이지란?

도구 상태 페이지은 code scanning 도구에 대한 정보를 표시하며, code scanning이 기대대로 작동하지 않을 때 문제 해결을 시작하는 데 유용합니다.

참고 항목

도구 상태 페이지는 조직 수준이 아닌 기본 분기의 리포지토리 수준에서만 도구 상태를 표시합니다.

도구 상태 표시기

도구 상태 페이지는 세 가지 상태 중 하나를 표시합니다.

  •         **모든 구성이 작동합니다.** 모든 도구가 예상대로 작동합니다.
    
  •         **일부 구성에는 주의가 필요합니다.** 일부 도구에는 경고 또는 중요하지 않은 문제가 있습니다.
    
  •         **일부 구성이 작동하지 않음**: 하나 이상의 도구에 심각한 오류가 있음
    

사용할 수 있는 정보

모든 code scanning 도구

  • 구성 상태 및 상태 진단
  • 스캔 일정
  • 첫 번째 및 가장 최근 검사 시간
  • 검사에 사용되는 규칙

CodeQL와 같은 통합 도구의 경우

위에 나열된 정보 외에도 통합 도구에 대한 도구 상태 페이지는 다음 세부 정보를 제공합니다.

  • 프로그래밍 언어별 파일 검사 백분율
  • 각 설치 유형에 대한 구성 세부 정보
  • 특정 오류 메시지
  • 분석된 파일의 다운로드 가능한 CSV 보고서
  • 사용된 규칙 및 경고 수의 다운로드 가능한 목록

CodeQL에서 스캔된 파일을 정의하는 방법

CodeQL는 파일의 일부 코드 줄이 처리된 경우 해당 파일을 검사된 것으로 보고합니다.

해석된 언어

  •         **기본 설정**: 검색된 파일에는 CodeQL에서 분석할 수 있는 언어에 대한 모든 소스 코드 파일이 포함됩니다.
    
  •         **고급 설정**: `paths` 및 `paths-ignore`를 사용하여 스캔할 파일을 정의할 수 있습니다. 
            [AUTOTITLE](/code-security/code-scanning/introduction-to-code-scanning/about-code-scanning-with-codeql)을(를) 참조하세요.
    

컴파일된 언어

도구 상태 페이지는 자동 빌드 또는 수동 빌드 단계를 실행하기 전에 있는 파일을 보고합니다. 빌드 프로세스 중에 생성된 파일은 표시되지 않습니다. 컴파일된 언어에 CodeQL 코드 스캐닝을(를) 참조하세요.

적용 범위 계산

파일 커버리지 비율은 pathspaths-ignore 구성 속성에 의해 제외된 파일을 고려합니다.

파일 커버리지 비율 이해

파일 검사 백분율을 사용하여 분석을 디버그하고 개선합니다.

  •         **높은 비율**: Code scanning이(가) 해당 언어에 대해 예상대로 작동합니다.
    
  •         **낮은 비율**: 진단 출력을 조사합니다. 
            [AUTOTITLE](/code-security/code-scanning/troubleshooting-code-scanning/codeql-scanned-fewer-lines-than-expected)을(를) 참조하세요.
    
  •         **백분율 0**: 현재 분석되지 않는 언어의 코드가 있을 수 있습니다. 이러한 언어를 포함하도록 설정을 업데이트합니다. 
            [AUTOTITLE](/code-security/code-scanning/creating-an-advanced-setup-for-code-scanning/customizing-your-advanced-setup-for-code-scanning#changing-the-languages-that-are-analyzed)을(를) 참조하세요.
    

참고 항목

고급 설정과 기본 설정을 모두 설정한 경우 도구 상태 페이지는 기본 설정만 표시합니다.

문제 해결 기능

도구 상태 페이지를 사용하면 다음을 통해 문제를 해결할 수 있습니다.

  •         **오류 메시지**: 제안된 작업에서 도구가 예상대로 작동하지 않는 이유를 설명합니다.
    
  •         **파일 검사 데이터**: 분석 중인 파일 및 언어 표시
    
  •         **구성 세부 정보**: 각 분석 실행에 대한 정보를 표시합니다.
    
  •         **다운로드 가능한 보고서**: CSV 보고서에 자세한 파일 및 규칙 정보 제공
    

추가 읽기

  •         [AUTOTITLE](/code-security/how-tos/scan-code-for-vulnerabilities/manage-your-configuration/use-the-tools-status-page-for-code-scanning)