GitHub 코드 품질 정보

GitHub Code Quality를 사용하여 끌어오기 요청 및 리포지토리 검사 시 코드 품질 문제를 식별하고, Copilot 기반 자동 수정 기능을 적용하며, 규칙 세트를 통해 표준을 적용할 수 있습니다.

이 문서의 내용

참고 항목

GitHub Code Quality은(는) 현재 공개 미리 보기에 있으며 변경될 수 있습니다. 공개 미리 보기에서 Code Quality은(는) 요금이 청구되지 않지만 Code Quality 스캔은 GitHub Actions 분을 소모합니다.

개요

GitHub Code Quality를 사용하면 코드베이스를 안정적으로 유지하고 유지 관리를 용이하게 하며 효율성을 높일 수 있습니다. 새 기능을 빌드하거나 기술 문제를 줄이거나 리포지토리 상태를 보고하는 경우 Code Quality는 리포지토리의 코드 상태를 효율적으로 개선하고 유지할 수 있도록 실행 가능한 인사이트와 자동화된 수정 사항을 제공합니다.

주요 기능 및 이점

Code Quality을 사용하면 다음을 수행 가능합니다.

  •         **끌어오기 요청** 및 **리포지토리 검사를** 통해 코드 품질 위험 및 기회를 식별합니다.
  • 결과에 대한 명확한 설명을 검토하고 한 번의 클릭으로 Copilot 기반 자동 수정을 적용합니다.
  •         **리포지토리 대시보드를** 사용하여 안정성 및 유지 관리 가능성 점수를 추적하고, 주의가 필요한 영역을 식별하고, 수정의 우선 순위를 지정합니다.
  • 끌어오기 요청에 대한 규칙 집합 을 설정하여 코드 품질 표준을 적용하고 조건을 충족하지 않는 변경 내용을 차단합니다.
  • Copilot 라이선스가 있는 경우, 수정 작업을 Copilot 코딩 에이전트 에 쉽게 할당할 수 있습니다.

가용성 및 사용 비용

GitHub Code Quality는 GitHub Team 및 GitHub Enterprise Cloud 플랜에 포함된 조직이 소유한 리포지토리에서 이용 가능합니다.

GitHub Code Quality은(는) 공개 미리 보기 중에 요금이 청구되지 않습니다. 하지만 Code Quality 검사를 실행하는 데에는 GitHub Actions분 정도가 걸립니다. GitHub Code Quality 청구을(를) 참조하세요.

참고 항목

  • Code Quality를 사용하거나 Copilot의 기능을 활용한 자동 수정 기능을 적용하면 Copilot 또는 Code Security 라이선스가 필요하지 않습니다.
  • 공개 미리 보기 단계에서 리포지토리 소유자가 Code Security의 사용을 차단하는 경우, enterprise 정책에 따라 Code Quality의 사용 또한 차단됩니다. 엔터프라이즈에서 GitHub Code Quality를 사용하는 것을 허용하기을(를) 참조하세요.

지원되는 언어

Code Quality는 CodeQL을 사용하여 다음과 같은 프로그래밍 언어에 대해 규칙 기반 분석을 수행합니다.

  • C#
  • Go
  • Java
  • JavaScript
  • 파이썬
  • 루비
  • TypeScript

Code Quality은(는) AI 기반 분석을 수행하며 그 결과는 별도로 "AI 결과" 리포지토리 대시보드에서 표시됩니다. 전체 코드베이스 및 끌어오기 요청을 검사하는 규칙 기반 CodeQL 분석과 달리, 이 AI 기반 분석은 최근 기본 분기에 푸시된 파일만 검사하고 위에 나열된 것 이상의 언어로 문제를 식별할 수 있습니다. 자세한 내용은 GitHub Code Quality의 책임 있는 사용을(를) 참조하세요.

사용 설정 후 Code Quality 결과가 표시되는 위치 이해하기

Code Quality를 리포지토리에서 사용하도록 설정하면 CodeQL 검색 결과를 볼 수 있습니다.

  • 기본 분기에 대해 열려 있는 모든 새 풀 리퀘스트
  • 업데이트할 때 기본 분기에 대한 모든 기존 끌어오기 요청이 새 CI 테스트 실행을 트리거합니다.
  • "코드 품질" 설정 페이지에 표시된 시간과 날짜의 기본 브랜치에 있는 전체 코드베이스

또한 기본 브랜치에 대한 모든 최근 푸시에 대한 인공지능 기반 분석을 볼 수 있습니다.

끌어오기 요청 결과

CodeQL에서 규칙 기반 문제를 발견하여 끌어오기 요청을 하면 github-code-quality[bot]에서 주석을 확인할 수 있습니다. 가능한 경우 각 주석은 문제 해결 방법에 대한 코파일럿 자동 수정 제안을 제공할 것입니다. 끌어오기 요청을 병합하기 전에 코드 품질 결과 수정을(를) 참조하세요.

기본 브랜치 결과

Code Quality의 기본 분기 결과는 리포지토리의 보안 탭에 있는 ‘코드 품질’ 페이지에 보고됩니다.

  •         **표준 결과** 는 CodeQL 품질 분석 결과를 보여 줍니다. 
        [AUTOTITLE](/code-security/code-quality/tutorials/improve-your-codebase)을(를) 참조하세요.

  •         **AI 결과** 은(는) 가장 최근에 기본 분기로 푸시된 파일에 대한 AI 기반 분석 결과를 보여 줍니다. 
        [AUTOTITLE](/code-security/code-quality/tutorials/improve-recent-merges)을(를) 참조하세요.

검사 정보

각 CodeQL 분석은 GitHub Actions분을 사용하며, 리포지토리의 작업 탭에서 동적 "코드 품질" 워크플로의 실행으로 볼 수 있습니다.

다음 단계