Skip to main content

끌어오기 요청에 대한 코드 품질 임계값 설정

리포지토리에 병합되는 코드의 품질을 높이기 위해 끌어오기 요청에 대한 Code Quality 게이트를 만드세요.

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

리포지토리 소유자, 조직 소유자, 보안 관리자 및 관리자 역할이 있는 사용자

참고 항목

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

소개

규칙 집합에 코드 품질 결과 요구 분기 규칙을 추가하고 필요한 심각도 수준을 지정하여, 코드 품질 표준을 충족하지 않는 끌어오기 요청을 차단할 수 있습니다. 끌어오기 요청이 이 임계값에 도달하지 않으면 병합할 수 없습니다.

필수 조건

참고 항목

임계값은 리포지토리에 지원되는 언어 중 하나 이상의 코드가 있는 경우에만 영향을 줍니다. GitHub Code Quality 활성화을 참조하세요.

끌어오기 요청에서 Code Quality이(가) 성공적으로 실행되는지 확인

Code Quality에 대한 임계값을 포함하도록 규칙 세트를 추가하거나 업데이트하기 전에 코드 품질 워크플로가 실행 중이며 결과를 끌어오기 요청에 다시 보고하고 있는지 확인하세요. 그렇지 않으면 규칙 집합이 모든 끌어오기 요청의 병합을 차단할 수 있습니다.

  1. 최근 끌어오기 요청을 열고 끌어오기 요청의 맨 아래에 있는 "검사" 요약으로 스크롤합니다.
  2. “CodeQL - 코드 품질” 검사가 성공적으로 실행되었고 상태를 보고했는지 확인하세요.

자세한 내용은 코드 품질에 대한 CodeQL 기반 분석을(를) 참조하세요.

Code Quality을(를) 포함하도록 규칙 세트 추가 또는 업데이트

  1. 리포지토리의 "설정" 탭으로 이동합니다.
  2. 왼쪽 사이드바의 "코드 및 자동화"에서 Rules를 확장한 다음 규칙 집합을 클릭합니다.
  3. 기본 분기를 보호하는 규칙 집합이 아직 없는 경우 새 규칙 집합 을 확장하고 새 분기 규칙 집합을 클릭합니다. 또는 기본 분기에 대한 기존 규칙 집합을 열고 5단계로 이동합니다.
  4. 새 규칙 집합을 만드는 경우:
    • 규칙 집합의 이름을 정의합니다.
    • "적용 상태"를 "활성"으로 설정합니다.
    • "대상 분기" 아래에서 "기본 분기 포함"의 대상을 추가합니다.
  5. "분기 규칙"에서 "코드 품질 결과 요구"를 활성화합니다.
  6. 끌어오기 요청을 기본 분기에 병합하기 전에 확인해야 하는 코드 품질 결과의 가장 낮은 심각도를 정의하려면 "심각도"를 설정합니다. 다음은 그 예입니다.
    • "오류"를 설정하여 확인되지 않은 코드 품질 오류가 병합되는 끌어오기 요청을 차단합니다.
    • 해결되지 않은 코드 품질 경고 또는 오류가 있는 끌어오기 요청이 병합되지 않도록 “경고 이상”을 설정하세요.
    • 해결되지 않은 코드 품질 참고 사항, 경고 또는 오류가 있는 끌어오기 요청이 병합되지 않도록 “참고 사항 이상”을 설정하세요.
    • "All"을 설정하여 확인되지 않은 코드 품질 결과가 병합되는 끌어오기 요청을 차단합니다.
  7. 규칙 집합 정의 또는 편집을 마쳤으면 만들기 또는 변경 내용 저장을 클릭합니다.

다음 단계

코드 품질 문제가 기본 분기에 도달하지 않도록 끌어오기 요청에서 GitHub Code Quality이(가) 어떻게 작동하는지 알아보세요. 끌어오기 요청을 병합하기 전에 코드 품질 결과 수정을(를) 참조하세요.