code scanning 구성 정보 알아보기
다양한 도구를 사용하여 리포지토리에서 code scanning을(를) 설정할 수 있습니다. 자세한 내용은 "코드 스캔을 위한 기본 설정 구성" 및 "코드 스캔을 위한 고급 설정 구성" 항목을 참조하세요.
사용할 수 있는 로그 및 진단 정보는 리포지토리의 code scanning에 사용하는 방법에 따라 달라집니다. 경고 목록의 도구 드롭다운 메뉴를 사용하여 리포지토리의 보안 탭에서 사용 중인 code scanning의 유형을 확인할 수 있습니다. 자세한 내용은 "리포지토리에 대한 코드 검사 경고 평가"을(를) 참조하세요.
분석 및 진단 정보 소개
GitHub에서 CodeQL 분석을 사용하여 실행된 code scanning에 대한 분석 및 진단 정보를 확인할 수 있습니다.
분석 정보는 경고 목록 맨 위에 있는 헤더의 최신 분석에 대해 표시됩니다. 자세한 내용은 "리포지토리에 대한 코드 검사 경고 평가"을(를) 참조하세요.
진단 정보는 작업 워크플로 로그에 표시되며 요약 메트릭과 추출 진단으로 구성됩니다. GitHub에서 code scanning 로그에 액세스하는 방법에 대한 자세한 내용은 아래의 "code scanning에서 로깅 출력 보기"를 참조하세요.
GitHub 외부에서 CodeQL CLI를 사용하는 경우 데이터베이스 분석 중에 생성된 출력에 진단 정보가 표시됩니다. 이 정보는 code scanning 결과와 함께 GitHub로 업로드하는 SARIF 결과 파일에도 포함됩니다.
CodeQL CLI에 대한 자세한 내용은 "CodeQL 쿼리를 사용하여 코드 분석"을(를) 참조하세요.
요약 메트릭 정보
요약 메트릭에는 다음이 포함됩니다.
- CodeQL 데이터베이스를 만들고 추출하기 전의 코드베이스의 코드 줄(기준으로 사용)
- 코드에서 추출된 CodeQL 데이터베이스(외부 라이브러리 및 자동 생성된 파일 포함)의 코드 줄
- CodeQL 데이터베이스(자동 생성된 파일 및 외부 라이브러리 제외)의 코드 줄
CodeQL 소스 코드 추출 진단 정보
추출기 진단은 분석 중에 확인된 파일만을 다룹니다. 메트릭은 다음과 같습니다.
- 성공적으로 분석된 파일 수
- 데이터베이스를 만드는 동안 추출기 오류가 발생한 파일 수
- 데이터베이스를 만드는 동안 추출기 경고가 발생한 파일 수
디버그 로깅을 사용하도록 설정하여 데이터베이스를 만드는 동안 발생한 CodeQL 추출기 오류 및 경고에 대한 자세한 정보를 볼 수 있습니다. 자세한 내용은 "로그가 충분히 자세히 설명되지 않음"을(를) 참조하세요.
code scanning의 로깅 출력 보기
이 섹션은 GitHub Actions(CodeQL 또는 타사)를 사용하여 실행된 code scanning에 적용됩니다.
리포지토리에 대한 code scanning을(를) 설정한 후에는 실행할 때 작업의 출력을 볼 수 있습니다.
-
리포지토리 이름 아래에서 작업을 클릭합니다.
code scanning 워크플로를 실행하기 위한 항목이 포함된 목록이 표시됩니다. 항목의 텍스트는 커밋 메시지에 지정한 제목입니다.
-
code scanning 워크플로의 항목을 클릭합니다.
Note
기본 설정을 사용하도록 설정하여 트리거되는 CodeQL 워크플로 실행을 찾고 있는 경우, 해당 항목의 텍스트는 “CodeQL”입니다.
-
왼쪽에서 작업 이름을 클릭합니다. 예: Analyze (LANGUAGE).
-
실행 시 이 워크플로의 작업에서 발생하는 로깅 출력을 검토합니다.
-
필요에 따라 워크플로 실행을 트리거한 커밋에 대한 자세한 내용을 보려면 짧은 커밋 해시를 클릭합니다. 짧은 커밋 해시는 커밋 작성자 사용자 이름 바로 다음에 있는 7자의 소문자입니다.
-
모든 작업이 완료되면 식별된 모든 code scanning 경고의 세부 정보를 볼 수 있습니다. 자세한 내용은 "리포지토리에 대한 코드 검사 경고 평가" 항목을 참조하세요.
