코드 스니펫

Tier: Free, Premium, Ultimate Offering: GitLab.com, Self-managed, GitLab Dedicated

GitLab 스니펫을 사용하면 코드 조각과 텍스트를 다른 사용자와 저장하고 공유할 수 있습니다. 이 스니펫은 주석을 남길, 복제할 수 있으며, 스니펫에서 버전 관리를 사용할 수 있습니다. 또한 여러 파일을 포함할 수도 있습니다. 또한 구문 강조, 임베딩, 다운로드하여 스니펫을 유지할 수도 있고, 스니펫 API를 통해 스니펫을 유지할 수도 있습니다.

GitLab은 두 가지 유형의 스니펫을 제공합니다:

  • 개인 스니펫: 특정 프로젝트와는 독립적으로 생성됩니다. 스니펫에는 가시성 수준을 설정할 수 있습니다: 공개 또는 비공개.
  • 프로젝트 스니펫: 항상 특정 프로젝트와 관련이 있습니다. 프로젝트 스니펫은 공개적으로 표시되거나 프로젝트 멤버에게만 표시될 수 있습니다.
note
2019년 7월부터 내부 가시성 설정은 GitLab.com의 새 프로젝트, 그룹 및 스니펫에 대해 비활성화되었습니다. 내부 가시성 설정을 사용하는 기존 스니펫은 이 설정을 유지합니다. 변경 사항에 대해 자세히 알아보려면 관련 이슈를 참조하십시오.

스니펫 생성

개인 또는 프로젝트 스니펫을 만들고 관리하는 방법에 따라 여러 가지 방법으로 스니펫을 만들 수 있습니다:

  1. 만들고자 하는 스니펫의 유형을 선택하십시오:
    • 개인 스니펫을 만들려면 다음 중 하나를 수행하십시오:
    • 프로젝트 스니펫을 만들려면: 프로젝트 페이지로 이동하십시오. 만들기 ()를 선택합니다. 이 프로젝트 내에서 아래의 새로운 스니펫을 선택하십시오.
  2. 제목에 제목을 추가하십시오.
  3. 선택 사항. 설명에 스니펫을 설명하십시오.
  4. 파일에서 파일에 적절한 이름과 확장자를 지정하십시오. 예: example.rb 또는 index.html. 적절한 확장자를 포함한 파일 이름은 구문 강조를 표시합니다. 파일 이름을 추가하지 않으면 알려진 복사 및 붙여넣기 버그가 발생할 수 있습니다. 파일 이름을 제공하지 않으면 GitLab에서 이름을 생성합니다.
  5. 선택 사항. 여러 파일을 스니펫에 추가하십시오.
  6. 가시성 수준을 선택하고 스니펫 만들기를 선택하십시오.

스니펫을 생성한 후에도 추가 파일을 추가할 수 있습니다. GitLab 13.0에서 이후에는 스니펫이 기본적으로 버전 관리됩니다.

스니펫 찾기

GitLab에서 볼 수 있는 모든 스니펫을 찾으려면 다음과 같은 방법을 사용할 수 있습니다.

  • 프로젝트의 스니펫 보기:
    1. 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트를 찾습니다.
    2. 코드 > 스니펫을 선택합니다.
  • 생성한 모든 스니펫 보기:
    1. 왼쪽 사이드바에서 검색 또는 이동을 선택합니다.
    2. 내 작업을 선택합니다.
    3. 스니펫을 선택합니다.

GitLab.com에서 직접 스니펫을 방문할 수도 있습니다.

  • 모든 공개 스니펫 탐색:
    1. 왼쪽 사이드바에서 검색 또는 이동을 선택합니다.
    2. 탐색을 선택합니다.
    3. 스니펫을 선택합니다.

GitLab.com에서 모든 공개 스니펫을 직접 방문할 수도 있습니다.

스니펫의 기본 가시성 변경

프로젝트 스니펫은 기본적으로 활성화되어 있습니다. 기본 가시성을 변경하려면:

  1. 프로젝트에서 설정 > 일반으로 이동하십시오.
  2. 가시성, 프로젝트 기능, 권한 섹션을 확장하고 스니펫으로 스크롤하십시오.
  3. 기본 가시성을 토글하고 스니펫이 모든 사람에게 표시되는지 또는 프로젝트 멤버만 표시되는지 선택하십시오.
  4. 변경 사항 저장을 선택하십시오.

버전 관리된 스니펫

  • 동영상에서 GitLab 13.0에 도입되었습니다.

GitLab 13.0 이후로 스니펫(개인 및 프로젝트 스니펫 모두)은 기본적으로 버전 관리가 활성화됩니다.

이는 모든 스니펫에 대한 기본 브랜치가 생성되는 지점에서 시작되는 스니펫의 자체 하부 리포지터리가 초기화된다는 것을 의미합니다. 스니펫을 변경하면 기본 브랜치에 대한 새로운 커밋이 기록됩니다. 커밋 메시지는 자동으로 생성됩니다. 스니펫의 리포지터리에는 하나의 브랜치만 있습니다. 이 브랜치를 삭제하거나 다른 브랜치를 만들 수 없습니다.

GitLab 13.0에서 기존 스니펫은 자동으로 마이그레이션되었습니다. 현재 내용이 스니펫 리포지터리의 초기 커밋으로 저장되었습니다.

파일 이름

스니펫은 파일 이름과 확장자 기준으로 구문 강조를 지원합니다. 파일 이름과 확장자를 지정하지 않고 스니펫을 제출할 수 있지만 리포지터리의 파일로 생성되기 위해 유효한 이름이 필요합니다.

스니펫에 지원되는 파일 이름 및 확장자를 지정하지 않은 경우, GitLab에서는 snippetfile<x>.txt 형식의 파일 이름을 추가합니다. 여기서 <x>는 파일에 추가된 번호를 나타냅니다. 이 번호는 무명의 스니펫을 계속 추가하면 계속 증가합니다.

GitLab 이전 버전에서 13.0으로 업그레이드할 때, 지원되는 파일 이름이 없는 기존 스니펫은 호환되는 형식으로 이름이 변경됩니다. 예: 스니펫의 파일 이름이 http://a-weird-filename.me인 경우, 이는 스니펫 리포지터리에 포함되기 위해 http-a-weird-filename-me으로 변경됩니다. 스니펫은 ID로 저장되기 때문에 파일 이름을 변경하면 스니펫에 대한 직접 또는 임베드된 링크가 손상됩니다.

여러 파일 추가 또는 삭제

단일 스니펫은 다음과 같은 관련 파일을 함께 유지하는 데 도움이 되는 최대 10개의 파일을 지원합니다.

  • 스크립트와 해당 출력을 포함하는 스니펫.
  • HTML, CSS 및 JavaScript 코드를 포함하는 스니펫.
  • docker-compose.yml 파일과 해당 .env 파일을 포함하는 스니펫.
  • 프로젝트를 시작하고 의존성을 관리하는 데 사용할 수 있는 gulpfile.js 파일 및 package.json 파일.

스니펫에 10개 이상의 파일이 필요한 경우 위키를 대신 만들어야 합니다. 위키는 모든 구독 수준의 프로젝트 및 그룹에서 사용할 수 있으며, GitLab Premium에서도 사용할 수 있습니다.

여러 파일이 있는 스니펫은 스니펫 디렉터리에서 파일 수를 표시합니다.

Git (Git 리포지터리에 의해 버전 관리됨)을 통해 스니펫을 관리하거나, 스니펫 API 및 GitLab UI를 통해 관리할 수 있습니다.

GitLab UI를 통해 스니펫에 새 파일을 추가하려면:

  1. GitLab UI에서 스니펫으로 이동합니다.
  2. 오른쪽 상단에 있는 편집을 선택합니다.
  3. 다른 파일 추가를 선택합니다.
  4. 제공된 양식 필드에 내용을 추가합니다.
  5. 변경 사항 저장을 선택합니다.

GitLab UI를 통해 스니펫에서 파일을 삭제하려면:

  1. GitLab UI에서 스니펫으로 이동합니다.
  2. 오른쪽 상단에 있는 편집을 선택합니다.
  3. 삭제하려는 각 파일 이름 옆의 파일 삭제를 선택합니다.
  4. 변경 사항 저장을 선택합니다.

스니펫 복제

업데이트를 받으려면 로컬로 복사하는 대신 스니펫을 복제합니다. 복제는 스니펫과 리포지터리의 연결을 유지시킵니다.

스니펫을 복제하려면:

  • 복제를 선택한 후 SSH 또는 HTTPS로 복제할 URL을 복사합니다.

스니펫을 복제하고 변경 사항을 GitLab에 푸시할 수 있습니다.

스니펫 임베드

공개 스니펫은 모든 웹사이트에 공유 및 임베딩될 수 있습니다. GitLab 스니펫을 여러 위치에서 재사용할 수 있으며, 소스의 변경이 임베드된 스니펫에 반영됩니다. 임베드된 경우 사용자는 다운로드하거나 스니펫을 원시 형식으로 볼 수 있습니다.

스니펫을 임베드하려면:

  1. 스니펫이 공개적으로 표시되는지 확인합니다:
    • 프로젝트 스니펫인 경우 프로젝트는 공개여야 합니다.
    • 스니펫은 공개적으로 표시됩니다.
    • 프로젝트에서 설정 > 일반으로 이동합니다. 가시성, 프로젝트 기능, 권한 섹션을 확장하고 스니펫으로 스크롤합니다. 스니펫 권한을 접근 권한 있는 사용자로 설정합니다.

  2. 스니펫의 임베드 섹션에서 복사를 선택하여 웹사이트 또는 블로그 게시물에 추가할 수 있는 한 줄 스크립트를 복사합니다. 예: 

    <script src="https://gitlab.com/namespace/project/snippets/SNIPPET_ID.js"></script>
  3. 스크립트를 파일에 추가합니다.

임베드된 스니펫은 다음을 표시하는 헤더가 표시됩니다.

  • 파일 이름(정의된 경우).
  • 스니펫 크기.
  • GitLab 링크.
  • 실제 스니펫 콘텐츠.

예를 들어:

스니펫 다운로드

스니펫의 원시 콘텐츠를 다운로드할 수 있습니다. 기본적으로 Linux 스타일의 줄 끝(LF)으로 다운로드됩니다. 원본 줄 끝을 유지하려면 매개변수 line_ending=raw를 추가해야 합니다 (예: https://gitlab.com/snippets/SNIPPET_ID/raw?line_ending=raw). GitLab 웹 인터페이스를 사용하여 스니펫이 생성된 경우 원본 줄 끝은 Windows 스타일 (CRLF)입니다.

스니펫에 댓글 작성

스니펫을 통해 코드 조각에 대한 대화에 참여하여 사용자 협업을 촉진할 수 있습니다.

스니펫을 스팸으로 표시

Tier: Free, Premium, Ultimate Offering: Self-managed, GitLab Dedicated

Self-managed GitLab 인스턴스의 관리자는 스니펫을 스팸으로 표시할 수 있습니다.

전제 조건:

  • 인스턴스의 관리자여야 합니다.
  • 인스턴스에서 Akismet 스팸 보호 기능이 활성화되어 있어야 합니다.

이 작업을 수행하려면:

  1. 왼쪽 사이드바에서 검색 또는 이동하여 프로젝트를 찾습니다.
  2. 코드 > 스니펫을 선택합니다.
  3. 스팸으로 신고할 스니펫을 선택합니다.
  4. 스팸으로 제출을 선택합니다.

GitLab은 스팸을 Akismet으로 전달합니다.

문제 해결

스니펫 제한 사항

  • 이진 파일은 지원되지 않습니다.
  • 브랜치의 생성 또는 삭제가 지원되지 않습니다. 기본 브랜치만 사용됩니다.
  • 스니펫 리포지터리에서 Git 태그는 지원되지 않습니다.
  • 스니펫의 리포지터리는 10개의 파일로 제한됩니다. 10개 이상의 파일을 푸시하려고 하면 오류가 발생합니다.
  • 사용자에게는 GitLab UI에서 리비전이 표시되지 않지만, 업데이트를 위한 이슈가 존재합니다.
  • 스니펫의 기본 최대 크기는 50MB입니다.
  • Git LFS는 지원되지 않습니다.

스니펫 리포지터리 크기 축소

버전이 지정된 스니펫은 네임스페이스 리포지터리 크기의 일부로 간주되기 때문에 스니펫 리포지터리를 가능한 작게 유지하는 것이 좋습니다.

리포지터리 크기를 줄이기 위한 도구에 대한 자세한 정보는 리포지터리 크기 축소 문서를 참조하십시오.

스니펫 텍스트 상자에 텍스트 입력이 불가능한 경우

텍스트 상자가 비활성화되어 새 스니펫을 만들지 못하는 경우 다음 해결방법을 사용하십시오:

  1. 스니펫에 제목을 입력합니다.
  2. 파일 추가를 선택하여 파일 추가를 스크롤합니다. GitLab은 두 번째 파일을 추가할 수 있는 두 번째 양식 필드 세트를 표시합니다.
  3. 두 번째 파일의 파일 이름 필드에 알려진 알려진 복사-붙여넣기 버그를 피하기 위해 파일 이름을 입력합니다.
  4. 두 번째 파일의 텍스트 영역에 문자열을 입력합니다.
  5. 첫 번째 파일 이름으로 스크롤하여 파일 삭제를 선택합니다.
  6. 나머지 파일을 만들고 완료되면 스니펫 생성을 선택합니다.

관련 주제