고급 검색 마이그레이션 리뷰 가이드라인

고급 검색 마이그레이션 리뷰 가이드라인에 대해 설명합니다.

이 페이지는 고급 검색 마이그레이션 리뷰에 특화되어 있습니다. 일반적인 코드 리뷰에 대한 광범위한 조언과 모범 사례는 코드 리뷰 가이드 를 참조하십시오. 리뷰가 필요한 경우 # 다음에 대해 고급 검색 마이그레이션 리뷰가 필요합니다: ee/elastic/migrate/ 의 파일 변경 인덱스 매핑 또는 설정 변경 Search::Elastic::References:: 또는 레거시 Elastic::Latest::InstanceProxy 클래스의 문서 직렬화 변경 인덱싱 동작이나 데이터 일관성에 영향을 미치는 변경 역할 # 작성자는 리뷰를 요청하기 전에 필수 아티팩트 를 제공해야 합니다. 리뷰어는 아티팩트가 완전한지 확인하고 1차 리뷰를 수행합니다. 관리자는 최종 리뷰를 수행하고 승인되면 병합합니다. 필수 아티팩트 # 리뷰를 요청할 때 다음을 제공해야 합니다. 머지 요청 설명에 이러한 항목이 포함되지 않은 경우 리뷰가 작성자에게 다시 할당됩니다. 모든 마이그레이션 # 마이그레이션 목적 : 마이그레이션이 무엇을 하는지, 왜 필요한지. 영향을 받는 문서 유형 : 어떤 인덱스와 문서 유형이 수정되는지(예: WorkItem , MergeRequest , Commit ). 하위 호환성 : 마이그레이션이 다중 버전 호환성을 처리하는 방법. 테스트 : 로컬에서 마이그레이션을 실행하고 실행 후 completed? 가 true를 반환하는지 확인. 배치 마이그레이션의 경우 배치 처리가 예상대로 작동하는지 확인. 매핑 또는 설정 변경 # 전후 비교 : 인덱스 구성에 대한 정확한 변경사항 표시. 영향 분석 : 변경이 기존 문서, 검색 동작 및 성능에 미치는 영향. 백필 또는 재인덱스 마이그레이션 # 데이터 볼륨 추정 : 영향을 받는 문서의 대략적인 수. 런타임 추정 : 계산 공식 을 사용하여 GitLab.com에서 예상 실행 시간. 배치 크기 근거 : 선택한 배치 크기와 제한 지연이 적절한 이유. 쿼리 계획 (해당하는 경우): 실행 중인 Elasticsearch 쿼리. 데이터 수정 마이그레이션 # 가역성 : 마이그레이션이 되돌릴 수 있음을 확인하거나 왜 불가능한지 설명. 데이터 안전성 : 데이터 손실 또는 손상에 대한 보호 조치. 유효성 검사 : 마이그레이션이 성공적으로 완료되었는지 확인하는 방법. 리뷰 체크리스트 # 기본 사항 # 마이그레이션이 스타일 가이드 형식을 따릅니다. 머지 요청에 변경 로그가 있습니다. 적절한 마이그레이션 헬퍼 가 사용됩니다. 공유 예시 를 사용하는 적절한 테스트 커버리지가 있는 사양 파일이 존재합니다. ee/elastic/docs/ 에 다음 필수 필드가 있는 YAML 문서 파일이 존재합니다: description - 마이그레이션이 하는 일 introduced_by_url - 마이그레이션을 도입한 머지 요청 링크 건너뛸 수 있는 마이그레이션의 경우: skippable: true 및 skip_condition 더 이상 사용되지 않는 마이그레이션의 경우: marked_obsolete_by_url 및 marked_obsolete_in_milest