라우팅
GitLab 백엔드는 주로 Rails로 작성되어 있으므로 Rails 라우팅을 사용합니다. Rails의 최선의 방법 외에도 GitLab 애플리케이션에 고유한 몇 가지 규칙이 있습니다. 서브그룹을 지원하기 위해 GitLab 프로젝트 및 그룹 라우트는 프로젝트 및 그룹 라우트를 일치시키기 위해 와일드카드 문자를 사용합니다. 예를 들어 다음과 같은 경로가 있을 수 있습니다:
/gitlab-com/customer-success/north-america/west/customerA
그러나 경로는 모호할 수 있습니다. 다음 예를 고려해보십시오:
/gitlab-com/edit
edit
라는 서브그룹이 있는지 또는 gitlab-com
그룹을 편집하는 특별한 엔드포인트인지가 모호합니다.
모호함을 제거하고 백엔드를 유지보수하기 쉽게하기 위해 /-/
스코프를 도입했습니다. 이것의 목적은 그룹 또는 프로젝트 경로를 나머지 경로와 구분하는 것입니다. 또한 예약된 이름의 수를 줄이는 데 도움이 됩니다.
모든 사용 가능한 경로 보기
다음을 실행하여 콘솔에서 경로를 볼 수 있습니다.
rails routes | grep crm
또는 브라우저에서 http://gdk.test:3000/rails/info/routes
로 이동하여 경로를 볼 수도 있습니다.
전역 경로
여러 전역 경로가 있습니다. 예를 들면:
/-/health
/-/metrics
그룹 경로
모든 그룹 경로는 /-/
스코프 아래에 있어야 합니다.
예시:
gitlab-org/-/edit
gitlab-org/-/activity
gitlab-org/-/security/dashboard
gitlab-org/serverless/-/activity
이를 달성하기 위해 scope '-'
메소드를 사용합니다.
프로젝트 경로
모든 프로젝트 경로는 /-/
스코프 아래에 있어야 하지만, Git 클라이언트 또는 기타 소프트웨어에서 다른 것을 요구하는 경우를 제외합니다.
예시:
gitlab-org/gitlab/-/activity
gitlab-org/gitlab/-/jobs/123
gitlab-org/gitlab/-/settings/repository
gitlab-org/serverless/runtimes/-/settings/repository
기존 경로 변경
기존 페이지의 URL을 변경하지 마십시오. 필요한 경우를 제외하고 사용자가 눈에 띄지 않도록 변경하십시오. 사용자가 404 Not Found
를 받지 않도록 피하려면됩니다. 다음 표는 다른 경우에 필요한 최소한의 사항을 설명합니다:
URL 설명 | 예시 | 해야 할 일 |
---|---|---|
스크립트 및 자동화에 사용될 수 있음 | snippet#raw
| 주요 릴리스에서 이전 및 새 URL을 모두 지원합니다. 그런 다음 다음 주요 릴리스에서 이전 URL에서 새 URL로의 리디렉션을 지원합니다. |
저장되거나 공유될 가능성이 높음 | issue#show
| 다음 주요 릴리스까지 이전 URL에서 새 URL로의 리디렉션을 추가합니다. |
제한된 사용, 공유되기 어려움 | admin#labels
| 추가 조치가 필요하지 않습니다. |
모든 경우에 이전 경로는 해당 트래픽이 충분히 낮아지면(예: 로그 또는 BigQuery에 따라) 제거되어야 합니다. 그렇지 않으면 제거 전에 사용자에게 해당 경로가 폐기되었음을 알리기 위해 더 많은 노력이 필요할 수 있습니다.
스코프되지 않은 경로 마이그레이션
현재 대부분의 경로는 /-/
스코프 아래에 있습니다. 그러나 나머지 일부를 마이그레이션하는 데 도움을 줄 수 있습니다! 경로를 마이그레이션하려면:
- 기존 경로를 수정하여
-
스코프를 추가합니다. -
Gitlab::Routing.redirect_legacy_paths
를 사용하여 레거시 경로에 대한 리디렉션을 추가합니다. - 나중의 릴리스에서 폐기된 경로를 제거하기 위해 기술적 부채 이슈를 만듭니다.
시작하려면 예시 병합 요청을 참조하십시오.