Skip to main content

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

리포지토리 또는 조직 수준에서 설정한 임계값 아래로 떨어지는 끌어오기 요청을 차단하여 코드 품질 표준을 자동으로 적용합니다.

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

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

GitHub Team 또는 GitHub Enterprise Cloud

규칙 집합에 임계값을 추가하여 Code Quality 코드 품질 표준을 충족하지 않는 끌어오기 요청을 차단할 수 있습니다. 끌어오기 요청이 임계값을 충족하지 않으면 병합할 수 없습니다.

다음의 임계값을 설정할 수 있습니다.

  • 해결이 필요한 결과의 최저 심각도별 CodeQL 결과
  • 코드 검사( 테스트로 처리해야 하는 코드의 최소 비율 기준)

포지토리 수준 또는 조직 수준에서 이러한 임계값을 적용하여 여러 리포지토리에 동일한 표준을 한 번에 적용할 수 있습니다. 팀 전체에서 일관된 품질 표시줄을 원하는 경우 조직 수준을 선택하고 단일 프로젝트에 고유한 표준이 필요한 경우 리포지토리 수준을 선택합니다. Code Quality AI 감지 항목은 임계값으로 설정할 수 없습니다.

필수 조건

참고

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

풀 리퀘스트에서 Code Quality가 성공적으로 실행되는지 확인

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

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

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

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

다음 단계에서는 리포지토리 수준에서 규칙 집합을 만들거나 업데이트합니다. 여러 리포지토리에 동일한 임계값을 동시에 적용하려면 대신 동일한 Require code quality results 규칙이 포함된 조직 규칙 세트를 생성하세요. 조직 내 리포지토리에 대한 규칙 세트 만들기을(를) 참조하세요.

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

코드 검사 임계값 설정

코드 검사 임계값 아래로 떨어지는 끌어오기 요청을 차단할 수도 있습니다. 위에서 사용한 코드 품질 요구 결과 규칙이 아닌 별도의 코드 검사 제한 규칙을 사용하며, 리포지토리는 먼저 코드 검사 데이터를 업로드해야 합니다. 전체 절차는 끌어오기 요청에 대한 코드 검사 임계값 설정을 참조하세요.

다음 단계

코드 품질 문제가 기본 브랜치에 도달하지 못하도록 끌어오기 요청에서 GitHub Code Quality 작동 방식을 알아봅니다. 코드 품질 문제가 기본 브랜치에 유입되는 것을 방지하기을(를) 참조하세요.