Push Rules(푸시 규칙) 개발 가이드라인
이 문서는 Push Rules의 코드 디자인을 이해하는 데 도움을 주기 위해 작성되었습니다. 이 기능의 코드를 변경하기 전에 이 문서를 읽어야 합니다.
이 문서는 코드가 자주 변경될 수 있기 때문에 코드가 어떻게 작동하는지를 이해하기 위한 개요로 의도적으로 제한되어 있습니다. 여기에 있는 세부 정보는 Push Rules 기능의 주요 컴포넌트가 어떻게 작동하는지 설명합니다.
이 문서는 이 문서에서 참조하는 코드베이스의 부분이 업데이트되거나 제거되거나 새로운 부분이 추가될 때 업데이트되어야 합니다.
비즈니스 로직
비즈니스 로직은 주로 두 곳에 포함되어 있습니다. PushRule 모델은 규칙의 설정을 저장하고, 그런 다음 이러한 설정을 사용하여 푸시 동작을 변경하는 확인이 있습니다.
-
PushRule: 각 푸시 규칙의 구성을 저장하는 데 사용되는 주요 모델입니다.-
ee/app/models/push_rule.rb에 정의되어 있습니다.
-
-
EE::Gitlab::Checks::DiffCheck: Diff check는 푸시 규칙의file_name_regex와 일치하는 파일 이름과id_rsa와 같은 알려진 비밀 파일과 일치하는 파일도 방지합니다.-
ee/lib/ee/gitlab/checks/diff_check.rb에 정의되어 있습니다.
-
-
EE::Gitlab::Checks::PushRuleCheck: 다양한 푸시 규칙 확인을 실행합니다.-
ee/lib/ee/gitlab/checks/push_rule_check.rb에 정의되어 있습니다.
-
-
EE::Gitlab::Checks::PushRules::BranchCheck: 브랜치 규칙과 관련된 푸시 규칙 확인을 실행합니다.-
ee/lib/ee/gitlab/checks/push_rules/branch_check.rb에 정의되어 있습니다.
-
-
EE::Gitlab::Checks::PushRules::CommitCheck: 커밋 규칙과 관련된 푸시 규칙 확인을 실행합니다.-
ee/lib/ee/gitlab/checks/push_rules/commit_check.rb에 정의되어 있습니다.
-
-
EE::Gitlab::Checks::PushRules::FileSizeCheck: 파일 크기 규칙과 관련된 푸시 규칙 확인을 실행합니다.-
ee/lib/ee/gitlab/checks/push_rules/file_size_check.rb에 정의되어 있습니다.
-
-
EE::Gitlab::Checks::PushRules::TagCheck: 태그 규칙과 관련된 푸시 규칙 확인을 실행합니다.-
ee/lib/ee/gitlab/checks/push_rules/tag_check.rb에 정의되어 있습니다.
-
진입점
다음 컨트롤러와 API는 모두 푸시 규칙 논리의 진입점입니다:
-
Admin::PushRulesController: 이 컨트롤러는 전역 푸시 규칙을 관리하는 데 사용됩니다. -
Group::PushRulesController: 이 컨트롤러는 그룹 수준의 푸시 규칙을 관리하는 데 사용됩니다. -
Project::PushRulesController: 이 컨트롤러는 프로젝트 수준의 푸시 규칙을 관리하는 데 사용됩니다. -
Api::Internal::Base: SSH를 통해 GitLab에 푸시하는 경우 사용자가 푸시할 수 있는지 확인하기 위해/internal/allowed엔드포인트가 호출됩니다./internal/allowed엔드포인트는Gitlab::Checks::DiffCheck을 수행합니다. EE에서는 여기에 푸시 규칙 확인이 포함됩니다.-
lib/api/internal/base.rb에 정의되어 있습니다.
-
-
Repositories::GitHttpController: 변경 사항이 HTTP를 통해 GitLab에 푸시되는 경우, 컨트롤러는 사용자가 푸시할 수 있는지 확인하기 위해 액세스 확인을 수행합니다. 이 검사는Gitlab::Checks::DiffCheck를 수행합니다. EE에서는 여기에 푸시 규칙 확인이 포함됩니다.-
app/controllers/repositories/git_http_controller.rb에 정의되어 있습니다.
-
플로우
다음 플로우차트는 컨트롤러에서 모델로의 플로우를 설명하는 데 도움이 될 것입니다.
SSH를 통한 Git 푸시
graph TD
Repositories::GitHttpController --> Gitlab::GitAccess
Api::Internal::Base --> Gitlab::GitAccess
Gitlab::GitAccess --> Gitlab::Checks::ChangesAccess
Gitlab::Checks::ChangesAccess --> Gitlab::Checks::SingleChangeAccess
Gitlab::Checks::ChangesAccess --> EE::Gitlab::Checks::PushRuleCheck
Gitlab::Checks::SingleChangeAccess --> Gitlab::Checks::DiffCheck
EE::Gitlab::Checks::PushRuleCheck -->|태그에 푸시하는 경우에만| EE::Gitlab::Checks::PushRules::TagCheck
EE::Gitlab::Checks::PushRuleCheck -->|브랜치에 푸시하는 경우에만| EE::Gitlab::Checks::PushRules::BranchCheck
EE::Gitlab::Checks::PushRuleCheck --> EE::Gitlab::Checks::PushRules::FileSizeCheck
PushRuleCheck은 parallel_push_checks 피처 플래그가 활성화되어 있는 경우에만 병렬로 확인을 트리거합니다. 그렇지 않으면 태그 또는 브랜치 확인이 먼저 실행되고 파일 크기가 실행됩니다.
도움말