• GitLab 패키지 레지스트리에 발행
  • 패키지 레지스트리에 대한 인증
  • 명명 규칙
• 명령줄을 통한 패키지 배포
  • .npmrc를 통한 인증
  • 명령줄을 통한 패키지 배포
• CI/CD 파이프라인을 사용한 패키지 배포
• 패키지 설치
  • 패키지 레지스트리에 인증하기
  • 인스턴스 레벨에서 설치
  • 그룹 레벨에서 설치
  • 프로젝트 레벨에서 설치
  • npmjs.com으로의 패키지 전달
• 패키지 폐기
  • 더 이상 사용되지 않는 경고 제거
• 유용한 힌트
  • 다른 조직에서 npm 패키지 설치
  • npm 메타데이터
  • npm 배포 태그 추가
    • CI/CD에서
  • 지원되는 CLI 명령어
• 문제 해결
  • npm install 또는 yarn에서 404 Not Found 오류 발생
  • npm publish이 기본 npm 레지스트리(registry.npmjs.org)를 대상으로 함
  • npm install이 npm ERR! 403 Forbidden을 반환함
  • npm publish 명령이 npm ERR! 400 Bad Request를 반환합니다.
  • 패키지 이름이 명명 규칙을 준수하지 않음
  • 패키지가 이미 존재함
  • 패키지 JSON 파일이 너무 큼
  • npm publish 명령이 npm ERR! 500 Internal Server Error - PUT를 반환합니다.

npm 패키지 패키지 레지스트리

특정 npm 패키지 관리자 클라이언트가 사용하는 API 엔드포인트에 대한 설명은 npm API 문서를 참조하십시오.

npm 또는 yarn 패키지를 빌드하는 방법을 알아보세요.

GitLab 패키지 레지스트리에 npm 패키지를 발행하는 비디오 데모를 시청하세요.

GitLab 패키지 레지스트리에 발행

패키지 레지스트리에 대한 인증

패키지를 발행하려면 토큰이 필요합니다. 달성하려는 목표에 따라 사용 가능한 다양한 토큰이 있습니다. 자세한 내용은 토큰에 대한 지침을 참조하십시오.

• 조직에서 2차 인증(2FA)을 사용하는 경우 api로 범위가 설정된 개인 액세스 토큰을 사용해야 합니다.
• CI/CD 파이프라인을 통해 패키지를 발행하는 경우 CI 작업 토큰을 사용해야 합니다.

토큰을 생성한 후 나중에 사용할 수 있도록 저장하세요.

여기에 문서화되지 않은 인증 방법을 사용하지 마십시오. 문서화되지 않은 인증 방법은 향후 제거될 수 있습니다.

명명 규칙

패키지를 설치하는 방법에 따라 명명 규칙을 준수해야 할 수 있습니다.

다음 세 가지 API 엔드포인트 중 하나를 사용할 수 있습니다.

• 인스턴스 수준: 서로 다른 GitLab 그룹이나 고유한 네임스페이스에 많은 npm 패키지가 있는 경우 사용합니다.
• 그룹 수준: 동일한 그룹 또는 하위 그룹의 다른 프로젝트에 많은 npm 패키지가 있는 경우 사용합니다.
• 프로젝트 수준: 몇 가지 npm 패키지가 있고 같은 GitLab 그룹에 속하지 않은 경우 사용합니다.

프로젝트 수준 또는 그룹 수준으로 패키지를 설치할 계획이라면 명명 규칙을 준수할 필요가 없습니다.

인스턴스 수준에서 패키지를 설치할 계획이라면 패키지를 scope를 포함하여 명명해야 합니다. 범위가 지정된 패키지는 @로 시작하고 @owner/package-name과 같은 형식을 가집니다. 패키지에 대한 범위는 .npmrc 파일의 publishConfig 옵션을 사용하여 패키지의 범위를 설정할 수 있습니다.

• @scope에 사용되는 값은 패키지를 호스팅하는 프로젝트의 루트가 아닌 패키지 자체의 소스 코드가 있는 프로젝트의 루트여야 합니다. 범위는 소문자여야 합니다.
• 패키지 이름은 원하는대로 지정할 수 있습니다.

package.json 파일의 패키지 이름이 이 규칙과 일치하는지 확인하십시오:

"name": "@my-org/package-name"

명령줄을 통한 패키지 배포

.npmrc를 통한 인증

package.json과 동일한 디렉터리에 .npmrc 파일을 생성하거나 편집하세요. .npmrc 파일에 다음 라인을 포함하세요:

@scope:registry=https://your_domain_name/api/v4/projects/your_project_id/packages/npm/
//your_domain_name/api/v4/projects/your_project_id/packages/npm/:_authToken="${NPM_TOKEN}"

• @scope를 root level group으로 대체하세요.
• your_domain_name을 도메인 이름으로 바꿔주세요. 예: gitlab.com.
• your_project_id는 프로젝트 개요 페이지에서 찾을 수 있는 프로젝트 ID입니다.
• "${NPM_TOKEN}"은 프로세스 후반부에 만들어진 토큰과 관련되어 있습니다.

명령줄을 통한 패키지 배포

.npmrc에서 "${NPM_TOKEN}"과 연결하세요. your_token을 배포 토큰, 그룹 액세스 토큰, 프로젝트 액세스 토큰 또는 개인 액세스 토큰으로 바꿔주세요.

NPM_TOKEN=your_token npm publish

이제 패키지가 패키지 레지스트리에 게시됩니다.

CI/CD 파이프라인을 사용한 패키지 배포

CI/CD 파이프라인을 사용하여 패키지를 게시할 때 사전 정의된 변수 ${CI_PROJECT_ID}와 ${CI_JOB_TOKEN}을 사용하여 프로젝트의 패키지 레지스트리에 인증할 수 있습니다. 이러한 변수를 사용하여 CI/CD 작업 실행 중에 .npmrc 파일을 생성합니다.

package.json을 포함하는 GitLab 프로젝트에서 .gitlab-ci.yml 파일을 편집하거나 만드세요. 예를 들어:

image: node:latest

stages:
  - deploy

publish-npm:
  stage: deploy
  script:
    - echo "@scope:registry=https://${CI_SERVER_HOST}/api/v4/projects/${CI_PROJECT_ID}/packages/npm/" > .npmrc
    - echo "//${CI_SERVER_HOST}/api/v4/projects/${CI_PROJECT_ID}/packages/npm/:_authToken=${CI_JOB_TOKEN}" >> .npmrc
    - npm publish

• @scope를 게시 중인 패키지의 scope로 대체하세요.

publish-npm 작업이 파이프라인에서 실행되면 패키지가 패키지 레지스트리에 발행됩니다.

패키지 설치

동일한 이름과 버전을 가진 여러 패키지가 있는 경우 가장 최근에 게시된 패키지가 검색됩니다.

GitLab 프로젝트, 그룹 또는 인스턴스에서 패키지를 설치할 수 있습니다:

• 인스턴스 수준: 서로 다른 GitLab 그룹이나 고유한 네임스페이스에 많은 npm 패키지가 있는 경우 사용합니다.
• 그룹 수준: 동일한 GitLab 그룹 내의 다른 프로젝트에 많은 npm 패키지가 있는 경우 사용합니다.
• 프로젝트 수준: 몇 가지 npm 패키지가 있고 같은 GitLab 그룹에 속하지 않은 경우 사용합니다.

패키지 레지스트리에 인증하기

개인 프로젝트 또는 개인 그룹에서 패키지를 설치하려면 패키지 레지스트리에 인증해야 합니다. 프로젝트 또는 그룹이 공개되어 있다면 인증이 필요하지 않습니다.

npm으로 인증하려면:

npm config set -- //your_domain_name/:_authToken=your_token

npm 7 버전이나 그 이전 버전을 사용하는 경우, 엔드포인트의 전체 URL을 사용하세요.

다음의 방법으로 설치하는 경우:

• 인스턴스 레벨에서:

  npm config set -- //your_domain_name/api/v4/packages/npm/:_authToken=your_token
  

• 그룹 레벨에서:

  npm config set -- //your_domain_name/api/v4/groups/your_group_id/-/packages/npm/:_authToken=your_token
  

• 프로젝트 레벨에서:

  npm config set -- //your_domain_name/api/v4/projects/your_project_id/packages/npm/:_authToken=your_token
  

이 예시에서:

• your_domain_name을 여러분의 도메인 이름으로 바꿉니다. 예를 들어, gitlab.com.
• your_group_id을 그룹의 홈페이지에서 찾을 수 있는 그룹 ID로 바꿉니다.
• your_project_id를 프로젝트 개요 페이지에서 찾을 수 있는 프로젝트 ID로 바꿉니다.
• your_token을 배포 토큰, 그룹 액세스 토큰, 프로젝트 액세스 토큰 또는 개인 액세스 토큰으로 바꿉니다.

인스턴스 레벨에서 설치

1. 패키지 레지스트리에 인증.

2. 레지스트리 설정

   npm config set @scope:registry https://your_domain_name.com/api/v4/packages/npm/
   

   • @scope를 패키지를 설치할 프로젝트의 루트 레벨 그룹으로 바꿉니다.
   • your_domain_name을 여러분의 도메인 이름으로 바꿉니다. 예를 들어, gitlab.com.
   • your_token을 배포 토큰, 그룹 액세스 토큰, 프로젝트 액세스 토큰 또는 개인 액세스 토큰으로 바꿉니다.

3. 패키지 설치

   npm install @scope/my-package
   

그룹 레벨에서 설치

• GitLab 16.0에서 npm_group_level_endpoints라는 플래그로 도입되었습니다. 기본적으로 비활성화되어 있습니다.
• GitLab 16.1에서 일반적으로 사용 가능합니다. npm_group_level_endpoints 피처 플래그가 제거되었습니다.

1. 패키지 레지스트리에 인증.

2. 레지스트리 설정

   npm config set @scope:registry=https://your_domain_name/api/v4/groups/your_group_id/-/packages/npm/
   

   • @scope를 패키지를 설치할 그룹의 루트 레벨 그룹으로 바꿉니다.
   • your_domain_name을 여러분의 도메인 이름으로 바꿉니다. 예를 들어, gitlab.com.
   • your_group_id를 그룹의 홈페이지에서 찾을 수 있는 그룹 ID로 바꿉니다.

3. 패키지 설치

   npm install @scope/my-package
   

프로젝트 레벨에서 설치

1. 패키지 레지스트리에 인증.

2. 레지스트리 설정

   npm config set @scope:registry=https://your_domain_name/api/v4/projects/your_project_id/packages/npm/
   

   • @scope를 패키지를 설치할 프로젝트의 루트 레벨 그룹으로 바꿉니다.
   • your_domain_name을 여러분의 도메인 이름으로 바꿉니다. 예를 들어, gitlab.com.
   • your_project_id를 프로젝트 개요 페이지에서 찾을 수 있는 프로젝트 ID로 바꿉니다.

3. 패키지 설치

   npm install @scope/my-package
   

npmjs.com으로의 패키지 전달

• GitLab 12.9에서 도입되었습니다.

패키지 레지스트리에서 npm 패키지를 찾을 수 없는 경우, GitLab은 요청 클라이언트가 npmjs.com으로 요청을 다시 보낼 수 있도록 HTTP 리디렉션을 응답합니다.

관리자는 Continuous Integration 설정에서 이 동작을 비활성화할 수 있습니다.

그룹 소유자는 그룹 패키지 및 레지스트리 설정에서 이 동작을 비활성화할 수 있습니다.

개선 사항은 에픽 3608에서 추적됩니다.

패키지 폐기

• GitLab 16.0에서 도입되었습니다.

패키지를 폐기하여 패키지를 가져올 때 폐기 경고가 표시될 수 있습니다.

전제 조건:

• 패키지 삭제와 같은 권한.
• 패키지 레지스트리에 인증.

명령줄에서 다음을 실행하세요:

npm deprecate @scope/package "폐기 메시지"

CLI는 @scope/package의 버전 범위도 허용합니다. 예를 들어:

npm deprecate @scope/package "모든 패키지 버전이 폐기되었습니다"
npm deprecate @scope/package@1.0.1 "버전 1.0.1만 폐기되었습니다"
npm deprecate @scope/package@"< 1.0.5" "1.0.5보다 작은 모든 패키지 버전이 폐기되었습니다"

더 이상 사용되지 않는 경고 제거

패키지의 사용되지 않는 경고를 제거하려면 메시지에 ""(빈 문자열)을 지정하십시오. 예를 들면:

npm deprecate @scope/package ""

유용한 힌트

다른 조직에서 npm 패키지 설치

GitLab 외부의 조직 및 사용자에게 패키지 요청을 라우팅할 수 있습니다.

이를 위해 .npmrc 파일에 line을 추가하십시오. @my-other-org를 프로젝트 리포지터리를 소유한 네임스페이스 또는 그룹으로 대체하고 조직의 URL을 사용하십시오. 이름은 대소문자를 구분하며 정확히 그룹 또는 네임스페이스의 이름과 일치해야 합니다.

@scope:registry=https://my_domain_name.com/api/v4/packages/npm/
@my-other-org:registry=https://my_domain_name.example.com/api/v4/packages/npm/

npm 메타데이터

GitLab 패키지 레지스트리는 npm 클라이언트에 다음 속성을 노출시킵니다. 이것들은 약식 메타데이터 형식과 유사합니다:

• name
• versions
  • name
  • version
  • deprecated
  • dependencies
  • devDependencies
  • bundleDependencies
  • peerDependencies
  • bin
  • directories
  • dist
  • engines
  • _hasShrinkwrap

npm 배포 태그 추가

새로 발행된 패키지에 배포 태그를 추가할 수 있습니다. 태그는 선택 사항이며 한 번에 한 패키지에만 할당할 수 있습니다.

태그를 지정하지 않고 패키지를 발행하면 latest 태그가 기본으로 추가됩니다. 태그나 버전을 지정하지 않고 패키지를 설치하면 latest 태그가 사용됩니다.

지원되는 dist-tag 명령어의 예시:

npm publish @scope/package --tag               # 새 태그로 패키지 발행
npm dist-tag add @scope/package@version my-tag # 기존 패키지에 태그 추가
npm dist-tag ls @scope/package                 # 패키지의 모든 태그 나열
npm dist-tag rm @scope/package@version my-tag  # 패키지에서 태그 삭제
npm install @scope/package@my-tag              # 특정 태그 설치

CI/CD에서

• GitLab 15.10에서 도입.

CI_JOB_TOKEN이나 배포 토큰 을 사용하여 GitLab CI/CD 작업에서 npm dist-tag 명령어를 실행할 수 있습니다. 예를 들면:

npm-deploy-job:
  script:
    - echo "//${CI_SERVER_HOST}/api/v4/projects/${CI_PROJECT_ID}/packages/npm/:_authToken=${CI_JOB_TOKEN}">.npmrc
    - npm dist-tag add @scope/package@version my-tag

npm 6.9.0에 버그가 있어 배포 태그 삭제가 실패합니다. npm 버전이 6.9.1 이상인지 확인하십시오.

지원되는 CLI 명령어

GitLab npm 레지스트리는 npm CLI (npm)와 yarn CLI (yarn)에 대한 다음 명령어를 지원합니다:

• npm install: npm 패키지 설치
• npm publish: npm 패키지를 레지스트리에 발행
• npm dist-tag add: npm 패키지에 배포 태그 추가
• npm dist-tag ls: 패키지의 배포 태그 나열
• npm dist-tag rm: 배포 태그 삭제
• npm ci: package-lock.json 파일에서 npm 패키지 직접 설치
• npm view: 패키지 메타데이터 표시
• npm pack: 패키지에서 tarball 생성
• npm deprecate: 패키지의 버전 사용 중지

문제 해결

npm install 또는 yarn에서 404 Not Found 오류 발생

다른 프로젝트에서 의존성이 있는 npm 패키지를 설치하려고 CI_JOB_TOKEN을 사용하면 404 Not Found 오류가 발생합니다. 패키지 및 해당 의존성에 액세스 권한이 있는 토큰으로 인증해야 합니다.

패키지 및 해당 의존성이 서로 다른 프로젝트에 있지만 동일한 그룹에 있는 경우 그룹 배포 토큰을 사용할 수 있습니다:

//gitlab.example.com/api/v4/packages/npm/:_authToken=<group-token>
@group-scope:registry=https://gitlab.example.com/api/v4/packages/npm/

패키지 및 해당 의존성이 여러 그룹에 퍼져 있는 경우 모든 그룹 또는 개별 프로젝트에 액세스 권한이 있는 사용자의 개인 접근 토큰을 사용할 수 있습니다:

//gitlab.example.com/api/v4/packages/npm/:_authToken=<personal-access-token>
@group-1:registry=https://gitlab.example.com/api/v4/packages/npm/
@group-2:registry=https://gitlab.example.com/api/v4/packages/npm/

npm publish이 기본 npm 레지스트리(registry.npmjs.org)를 대상으로 함

package.json 및 .npmrc 파일에서 패키지 스코프를 일관되게 설정했는지 확인하십시오.

예를 들어, GitLab에서 프로젝트 이름이 @scope/my-package인 경우 package.json 파일은 다음과 같아야 합니다:

{
  "name": "@scope/my-package"
}

그리고 .npmrc 파일은 다음과 같아야 합니다:

@scope:registry=https://your_domain_name/api/v4/projects/your_project_id/packages/npm/
//your_domain_name/api/v4/projects/your_project_id/packages/npm/:_authToken="${NPM_TOKEN}"

npm install이 npm ERR! 403 Forbidden을 반환함

이 오류가 발생하면 다음을 확인하십시오:

• 패키지 레지스트리가 프로젝트 설정에서 활성화되어 있는지 확인하십시오. 패키지 레지스트리는 기본적으로 활성화되어 있지만 비활성화할 수도 있습니다.
• 토큰이 만료되지 않았고 적절한 권한을 가지고 있는지 확인하십시오.
• 같은 스코프 내에서 동일한 이름 또는 버전의 패키지가 이미 존재하지 않은지 확인하십시오.
• 스코프 패키지의 URL에 후행 슬래시가 포함되어 있는지 확인하십시오:
  • 올바름: //gitlab.example.com/api/v4/packages/npm/
  • 잘못됨: //gitlab.example.com/api/v4/packages/npm

translated with https://www.deepl.com/translator

npm publish 명령이 npm ERR! 400 Bad Request를 반환합니다.

이 오류가 발생하는 경우 다음과 같은 문제 중 하나가 원인일 수 있습니다.

패키지 이름이 명명 규칙을 준수하지 않음

패키지 이름이 @scope/package-name 패키지 명명 규칙을 준수하지 않을 수 있습니다.

명칭이 정확하게 규칙을 준수하는지, 대소문자를 포함하여 확인한 후 다시 발행을 시도하세요.

패키지가 이미 존재함

이미 패키지가 동일한 루트 네임스페이스의 다른 프로젝트에 발행되어 있으므로 동일한 이름을 사용하여 다시 발행할 수 없습니다.

이전에 발행된 패키지가 이름은 같지만 버전이 다를 경우에도 동일한 상황이 발생합니다.

패키지 JSON 파일이 너무 큼

package.json 파일이 20,000자를 초과하지 않도록 확인하세요.

npm publish 명령이 npm ERR! 500 Internal Server Error - PUT를 반환합니다.

이는 GitLab 13.3.x 이후 버전에서의 알려진 문제입니다. 로그에 표시된 오류는 다음과 같습니다:

>NoMethodError - undefined method `preferred_language' for #<Rack::Response

이에 덧붙여 다른 오류가 표시될 수도 있습니다:

>Errno::EACCES","exception.message":"Permission denied

이는 일반적으로 다음 중 하나의 권한 문제입니다:

• packages_storage_path의 기본 값인 /var/opt/gitlab/gitlab-rails/shared/packages/.
• 객체 스토리지 를 사용하는 경우 원격 버킷.

후자의 경우, 버킷이 존재하고 GitLab이 쓰기 권한을 갖도록 확인하세요.