규칙 집합을 사용하여 엔터프라이즈에서 코드 거버넌스 시행

소개

사용자가 엔터프라이즈 전체의 리포지토리에 있는 코드와 상호 작용하는 방법을 제어하는 규칙 집합을 만들 수 있습니다. 다음이 가능합니다.

• 특정 분기에 커밋을 푸시할 수 있는 사용자, 커밋의 형식을 지정하는 방법, 태그를 삭제하거나 이름을 바꿀 수 있는 사용자와 같은 항목을 제어하기 위해 분기 또는 규칙 집합을 만듭니다.
• 프라이빗 또는 내부 리포지토리와 리포지토리의 전체 포크 네트워크에 대한 푸시를 차단하는 푸시 규칙 집합을 만듭니다. 푸시 규칙 집합을 사용하면 파일 확장명, 파일 경로 길이, 파일 및 폴더 경로 및 파일 크기에 따라 푸시를 차단할 수 있습니다.

자세히 알아보려면 규칙 세트 정보을(를) 참조하세요.

미리 빌드된 규칙 집합 가져오기

GitHub에서 만든 미리 빌드된 규칙 집합을 가져오려면 github/ruleset-recipes를 참조하세요.

JSON 파일을 사용하여 기존 규칙 집합을 가져올 수 있습니다. 여러 리포지토리 또는 조직에 동일한 규칙 집합을 적용하려는 경우에 유용할 수 있습니다. 자세한 내용은 "조직의 리포지토리에 대한 규칙 집합 관리"을(를) 참조하세요.

규칙 집합이 적용되는 위치를 정의하려면 어떻게 해야 하나요?

규칙 집합을 사용하면 규칙을 적용할 조직, 리포지토리, 분기를 유연하게 대상으로 지정할 수 있습니다.

• 조직을 대상으로 지정하려면 모두 선택하거나 목록에서 선택하거나 fnmatch 구문을 사용하여 조직 이름에 대한 동적 패턴을 정의할 수 있습니다. 구문 세부 정보는 리포지토리에 대한 규칙 세트 만들기을(를) 참조하세요.
• 이러한 조직 내에서 모든 리포지토리를 대상으로 지정하거나 또는 사용자 지정 속성별로 동적 목록을 대상으로 지정할 수 있습니다. 조직의 리포지토리에 대한 사용자 지정 속성 관리을(를) 참조하세요.
• 리포지토리 내에서 특정 분기 또는 태그(모든 분기, 기본 분기 또는 fnmatch 구문을 사용하는 동적 목록)를 대상으로 지정할 수 있습니다.

리포지토리에서 분기를 대상으로 지정하는 규칙 집합을 만들 때 리포지토리 관리자는 더 이상 분기의 이름을 바꾸거나 대상 리포지토리의 기본 분기를 변경할 수 없습니다. 적절한 권한이 있는 경우에도 계속 분기를 만들고 삭제할 수 있습니다.

커밋 형식을 제어하려면 어떻게 해야 하나요?

분기 또는 태그 규칙 집합에서 커밋 메시지 또는 작성자 메일과 같은 커밋 메타데이터의 형식을 제한하는 규칙을 추가할 수 있습니다.

Must match a given regex pattern restriction을 선택하는 경우 정규식 구문을 사용하여 메타데이터가 일치해야 하거나 일치하지 않아야 하는 패턴을 정의할 수 있습니다. 구문 세부 정보 및 예제에 관한 내용은 리포지토리에 대한 규칙 세트 만들기을(를) 참조하세요.

규칙 집합 적용 상태 사용

규칙 세트를 만들거나 편집하는 동안 적용 상태를 사용하여 규칙 세트를을 적용하는 방법을 구성할 수 있습니다.

규칙 세트에 대해 다음 적용 상태 중에서 선택할 수 있습니다.

• 활성: 규칙 세트가 생성 시에 적용됩니다.
• 평가: 규칙 세트가 적용되지 않지만 “규칙 인사이트” 페이지에서 규칙을 위반하거나 위반하지 않는 작업을 모니터링할 수 있습니다.
• 사용 안 함: 규칙 세트가 적용되거나 평가되지 않습니다.

"평가" 모드를 사용하는 것은 규칙 세트를 적용하지 않고 테스트하는 데 유용한 옵션입니다. "규칙 인사이트" 페이지를 사용하여 기여가 규칙을 위반했는지 확인할 수 있습니다. 자세한 내용은 리포지토리에 대한 규칙 세트 관리을(를) 참조하세요.

분기 또는 태그 규칙 세트 만들기

1. GitHub의 오른쪽 위 모서리에서 프로필 사진을 클릭합니다.

2. 사용자 환경에 따라 사용자 엔터프라이즈를 클릭하거나 사용자 엔터프라이즈를 클릭한 다음, 보고 싶은 엔터프라이즈를 클릭합니다.

3. 페이지 왼쪽의 엔터프라이즈 계정 사이드바에서 정책을 클릭합니다.

4. "Policies"에서 Code를 클릭합니다.

5. 새 규칙 세트를 클릭합니다.

6. 분기를 대상으로 하는 규칙 세트를 만들려면 새 분기 규칙 세트를 클릭합니다. 또는 태그를 대상으로 하는 규칙 집합을 만들려면 새 태그 규칙 집합을 클릭합니다.

7. "규칙 집합 이름" 아래에 규칙 집합의 이름을 입력합니다.

8. 필요에 따라 기본 적용 상태를 변경하려면 사용 안 함 을 클릭하고 적용 상태를 선택합니다. 적용 상태에 대한 자세한 내용은 규칙 세트 정보을(를) 참조하세요.

분기 또는 태그 규칙 집합에 대한 바이패스 권한 부여

특정 역할, Teams 또는 앱 바이패스 권한을 부여할 뿐만 아니라 규칙 집합에 대한 바이패스 요청을 승인하는 기능도 부여할 수 있습니다.

다음 사람에게는 바이패스 액세스 권한이 부여됩니다.

• 리포지토리 관리자, 조직 소유자, 엔터프라이즈 소유자
• 유지 관리 또는 쓰기 역할, 혹은 배포 키

1. 규칙 집합에 바이패스 권한을 부여하려면 '바이패스 목록' 섹션에서 Add bypass를 클릭하세요.

2. 표시되는 "바이패스 추가" 모달 대화 상자에서 바이패스 권한을 부여할 역할, 팀 또는 앱을 검색한 다음 "제안" 섹션에서 역할, 팀 또는 앱을 선택하고 선택한 항목 추가를 클릭합니다.

3. 필요에 따라 리포지토리에 직접 푸시하지는 못하도록 하면서 행위자에게 바이패스 권한을 부여하려면 '항상 허용' 오른쪽에서 클릭 후 pull request에 대해서만을 클릭합니다.

   이제 선택한 행위자가 pull request를 열어서 리포지토리를 변경하여 pull request 및 감사 로그에서 변경 내용을 명확하게 추적해야 합니다. 그러면 행위자가 분기 보호를 바이패스하고 끌어오기 요청을 병합하도록 선택할 수 있습니다.

엔터프라이즈에서 대상으로 지정할 조직 선택

모든 조직을 선택하거나, 기존 조직을 선택하거나, 이름별로 동적 목록을 설정합니다. Enterprise Managed Users를 사용하는 경우 엔터프라이즈의 사용자가 소유한 모든 리포지토리를 대상으로 지정하도록 선택할 수도 있습니다.

동적 목록을 설정하는 경우 fnmatch 구문을 사용하여 하나 이상의 명명 패턴을 추가합니다. 예를 들어, *open-source 문자열은 이름이 open-source로 끝나는 모든 조직과 일치합니다. 구문 세부 정보는 "리포지토리에 대한 규칙 세트 만들기"을(를) 참조하세요.

엔터프라이즈에서 대상으로 지정할 리포지토리 선택

선택한 조직 내에서 모든 리포지토리를 대상으로 지정하거나 사용자 지정 속성별로 동적 목록을 대상으로 지정할 수 있습니다. 조직의 리포지토리에 대한 사용자 지정 속성 관리을(를) 참조하세요.

대상으로 지정할 분기 또는 태그 선택

분기 또는 태그를 대상으로 지정하려면 "대상 분기" 또는 "대상 태그" 섹션에서 대상 추가를 선택한 다음 분기 또는 태그를 포함하거나 제외할 방법을 선택합니다. fnmatch 구문을 사용하여 패턴에 따라 분기 또는 태그를 포함하거나 제외할 수 있습니다. 자세한 내용은 fnmatch 구문 사용을 참조하세요.

동일한 규칙 세트에 여러 대상 지정 조건을 추가할 수 있습니다. 예를 들어 기본 분기를 포함하고 *feature* 패턴과 일치하는 분기를 포함한 다음, not-a-feature 패턴과 일치하는 분기를 명시적으로 제외할 수 있습니다.

분기 또는 태그 보호 선택

"분기 보호" 또는 "태그 보호" 섹션에서 규칙 세트에 포함할 규칙을 선택합니다. 규칙을 선택하면 규칙에 대한 추가 설정을 입력할 수 있습니다. 규칙에 대한 자세한 내용은 "규칙 세트에 사용 가능한 규칙"을(를) 참조하세요.

메타데이터 제한 추가

메타데이터 제한은 리포지토리의 커밋 간의 일관성을 높이기 위한 것입니다. 끌어오기 요청을 통해 코드 검토를 요구하는 등의 보안 조치를 대체하기 위한 것이 아닙니다.

1. 커밋 메타데이터 또는 분기 이름을 제어하는 ​​규칙을 추가하려면 규칙 세트를 생성하거나 편집할 때 "제한" 섹션에서 커밋 메타데이터 제한 또는 분기 이름 제한을 클릭합니다.

2. 제한 설정을 구성한 다음 추가를 클릭합니다. 동일한 규칙 세트에 여러 제한을 추가할 수 있습니다.

3. 지정된 regex 패턴과 일치하려면 "요구 사항" 드롭다운에서 지정된 regex 패턴과 일치해야 함을 선택합니다.

   "일치하는 패턴으로 시작해야 함"과 같은 대부분의 요구 사항에서 입력하는 패턴은 문자 그대로 해석되며 와일드카드는 지원되지 않습니다. 예를 들어 * 문자는 리터럴 * 문자만 나타냅니다.

   더 복잡한 패턴의 경우 "지정된 regex 패턴과 일치해야 함" 또는 "지정된 정규식 패턴과 일치하지 않아야 함"을 선택한 다음 정규식 구문을 사용하여 일치하는 패턴을 정의할 수 있습니다. 자세한 내용은 GitHub Enterprise Cloud 설명서의 커밋 메타데이터에 대한 정규식 정보."

   리포지토리에 대한 규칙 세트를 보는 모든 사용자는 여러분이 제공한 설명을 볼 수 있습니다.

4. 선택적으로 메타데이터 제한이 있는 규칙 세트를 적용하기 전에 규칙 세트에 대한 "평가" 적용 상태 선택하여 기여자에게 영향을 주지 않으면서 메타데이터 제한의 효과를 테스트할 수 있습니다. 메타데이터 제한에 대한 자세한 내용은 규칙 세트에 사용 가능한 규칙을(를) 참조하세요.

분기 또는 태그 규칙 집합 완료 및 다음 단계

규칙 세트 만들기를 마치려면 만들기를 클릭합니다. 규칙 세트의 적용 상태가 "활성"으로 설정된 경우 규칙 세트가 즉시 적용됩니다.

규칙 세트에 대한 인사이트를 보고 규칙이 기여자에게 미치는 영향을 확인할 수 있습니다. 적용 상태가 "평가"로 설정된 경우 규칙 세트가 활성 상태이면 어떤 작업이 통과했거나 실패했는지 확인할 수 있습니다. 규칙 세트의 인사이트에 대한 자세한 내용은 리포지토리에 대한 규칙 세트 관리을(를) 참조하세요.

푸시 규칙 집합 만들기

엔터프라이즈의 프라이빗 또는 내부 리포지토리의 푸시 규칙 집합을 만들 수 있습니다.

1. GitHub의 오른쪽 위 모서리에서 프로필 사진을 클릭합니다.
2. 사용자 환경에 따라 사용자 엔터프라이즈를 클릭하거나 사용자 엔터프라이즈를 클릭한 다음, 보고 싶은 엔터프라이즈를 클릭합니다.
3. 왼쪽 사이드바의 "Policies" 섹션에서 Code를 클릭합니다.
4. 새 규칙 세트를 클릭합니다.
5. New push ruleset을 클릭합니다.
6. "규칙 집합 이름" 아래에 규칙 집합의 이름을 입력합니다.
7. 필요에 따라 기본 적용 상태를 변경하려면 Disabled를 클릭하고 적용 상태를 선택합니다. 적용 상태에 대한 자세한 내용은 규칙 세트 정보을(를) 참조하세요.

푸시 규칙 집합에 대한 바이패스 권한 부여

특정 역할, Teams 또는 앱 바이패스 권한을 부여할 뿐만 아니라 규칙 집합에 대한 바이패스 요청을 승인하는 기능도 부여할 수 있습니다. 다음 사람에게는 바이패스 액세스 권한이 부여됩니다.

• 리포지토리 관리자, 조직 소유자, 엔터프라이즈 소유자
• 유지 관리 또는 쓰기 역할, 혹은 키 배포

1. 규칙 집합에 바이패스 권한을 부여하려면 '바이패스 목록' 섹션에서 Add bypass를 클릭하세요.
2. 표시되는 "바이패스 추가" 모달 대화 상자에서 바이패스 권한을 부여할 역할, 팀 또는 앱을 검색한 다음 "제안" 섹션에서 역할, 팀 또는 앱을 선택하고 선택한 항목 추가를 클릭합니다.

엔터프라이즈에서 대상으로 지정할 조직 선택

모든 조직을 선택하거나, 기존 조직을 선택하거나, 이름별로 동적 목록을 설정합니다. Enterprise Managed Users를 사용하는 경우 엔터프라이즈의 사용자가 소유한 모든 리포지토리를 대상으로 지정하도록 선택할 수도 있습니다.

동적 목록을 설정하는 경우 fnmatch 구문을 사용하여 하나 이상의 명명 패턴을 추가합니다. 예를 들어, *open-source 문자열은 이름이 open-source로 끝나는 모든 조직과 일치합니다. 구문 세부 정보는 "리포지토리에 대한 규칙 세트 만들기"을(를) 참조하세요.

엔터프라이즈에서 대상으로 지정할 리포지토리 선택

선택한 조직 내에서 모든 리포지토리를 대상으로 지정하거나 사용자 지정의 속성을 사용하여 동적 목록을 대상으로 지정할 수 있습니다. 조직의 리포지토리에 대한 사용자 지정 속성 관리을(를) 참조하세요.

푸시 보호 선택

파일 확장명, 파일 경로 길이, 파일 및 폴더 경로, 파일 크기에 따라 이 리포지토리와 이 리포지토리의 전체 포크 네트워크에 대한 푸시를 차단할 수 있습니다.

구성하는 모든 푸시 방지는 이 리포지토리와 이 리포지토리의 전체 포크 네트워크에서 푸시를 차단합니다.

1. "보호 방지" 아래에서 적용하려는 제한을 클릭합니다. 그런 다음 선택한 제한 사항에 대한 세부 정보를 입력합니다.

   파일 경로 제한에 부분 또는 전체 경로를 사용할 수 있습니다. 이 테스트에 fnmatch 구문을 사용할 수 있습니다. 예를 들어 test/demo/**/*를 대상으로 하는 제한은 test/demo/ 디렉터리의 파일이나 폴더에 대한 푸시를 방지합니다. test/docs/pushrules.md를 대상으로 하는 제한 사항은 test/docs/ 디렉터리의 pushrules.md 파일에 대한 푸시를 방지합니다. 자세한 내용은 리포지토리에 대한 규칙 세트 만들기을(를) 참조하세요.

푸시 규칙 집합 완료 및 다음 단계

규칙 세트 만들기를 마치려면 만들기를 클릭합니다. 규칙 세트의 적용 상태가 "활성"으로 설정된 경우 규칙 세트가 즉시 적용됩니다.

규칙 세트에 대한 인사이트를 보고 규칙이 기여자에게 미치는 영향을 확인할 수 있습니다. 적용 상태가 "평가"로 설정된 경우 규칙 세트가 활성 상태이면 어떤 작업이 통과했거나 실패했는지 확인할 수 있습니다. 규칙 세트의 인사이트에 대한 자세한 내용은 리포지토리에 대한 규칙 세트 관리을(를) 참조하세요.