For testing:

• 문서 파일 간 상대 링크는 Lychee를 사용합니다.

• GitLab UI에서 문서로 연결되는 링크는 haml-lint, eslint, rubocop을 사용합니다.

상대 링크 테스트 로컬 실행#

상대 링크 테스트를 로컬에서 실행하려면 다음 중 하나를 선택할 수 있습니다:

• 문서를 포함하는 단일 프로젝트에 대해 링크 검사를 실행합니다.

• GitLab 문서 사이트 전체 로컬 복사본에 대해 링크 검사를 실행합니다.

단일 프로젝트 검사#

단일 프로젝트의 링크를 검사하려면:

• Lychee를 설치합니다.

• 프로젝트의 루트 디렉터리로 이동합니다.

• lychee --offline --include-fragments <doc_directory>를 실행합니다. 여기서 <doc_directory>는 검사할 문서가 포함된 디렉터리입니다. 예: lychee --offline --include-fragments doc.

전체 GitLab Docs 사이트 프로젝트 검사#

전체 GitLab 문서 사이트의 링크를 검사하려면:

• docs-gitlab-com 클론과 동일한 디렉터리에 모든 문서 프로젝트가 클론되어 있는지 확인합니다. make clone-docs-projects를 실행하면 해당 위치에 없는 프로젝트를 클론할 수 있습니다.

• docs-gitlab-com 디렉터리로 이동합니다.

• hugo를 실행하여 GitLab Docs 사이트를 빌드합니다.

• lychee --offline public을 실행하여 링크를 검사합니다.

UI 링크 테스트 로컬 실행#

GitLab 코드 파일에서 문서 링크를 로컬에서 테스트하려면 다음을 실행할 수 있습니다:

• eslint: 프론트엔드(.js 및 .vue) 파일용.

• rubocop: .rb 및 .haml 파일용.

eslint 테스트 실행#

• 터미널 창에서 gitlab 디렉터리를 엽니다.

• 다음을 실행합니다:

scripts/frontend/lint_docs_links.mjs

이 테스트를 처음 실행할 때 오류가 발생하면 yarn install을 실행하여 GitLab의 의존성을 설치한 후 다시 시도하세요.

rubocop 테스트 실행#

• RuboCop을 설치합니다.

• 터미널 창에서 gitlab 디렉터리를 엽니다.

• 모든 Ruby 파일에 대해 검사를 실행하려면:

rubocop --only Gitlab/DocumentationLinks/Link

단일 Ruby 파일에 대해 검사를 실행하려면:

rubocop --only Gitlab/DocumentationLinks/Link path/to/ruby/file.rb