Yarn을 사용하여 패키지를 게시합니다
Yarn 1 (Classic) 및 Yarn 2+을 사용하여 패키지를 게시할 수 있습니다.
배포 컨테이너에서 사용된 Yarn 버전을 확인하려면 yarn publish를 호출하는 CI 스크립트 작업 블록의 script 블록에서 yarn --version을 실행합니다. Yarn 버전은 파이프라인 출력에 표시됩니다.
Yarn 패키지를 빌드하는 방법을 배우세요.
Yarn 문서를 사용하여 Yarn Classic 및 Yarn 2+로 시작할 수 있습니다.
GitLab 패키지 레지스트리에 게시
Yarn을 사용하여 GitLab 패키지 레지스트리에 게시할 수 있습니다.
패키지 레지스트리의 인증
패키지를 게시하려면 토큰이 필요합니다. 원하는 기능에 따라 다양한 토큰을 사용할 수 있습니다. 자세한 내용은 토큰 지침을 참조하세요.
- 조직에서 이중 인증 (2FA)을 사용하는 경우,
api로 범위가 설정된 개인 액세스 토큰을 사용해야 합니다. - CI/CD 파이프라인을 통해 패키지를 게시하는 경우, 프라이빗 러너에서 CI 작업 토큰을 사용하거나 인스턴스 러너의 경우 변수를 등록할 수 있습니다.
게시 구성
게시를 위해 .yarnrc.yml에 다음 구성을 설정합니다. 이 파일은 package.json이 있는 패키지 프로젝트 소스의 루트 디렉토리에 있어야 합니다.
npmScopes:
<my-org>:
npmPublishRegistry: 'https://<your_domain>/api/v4/projects/<your_project_id>/packages/npm/'
npmAlwaysAuth: true
npmAuthToken: '<your_token>'
이 구성에서:
-
<my-org>를 귀하의 조직 범위로 바꿉니다.@기호는 제외합니다. -
<your_domain>을 귀하의 도메인 이름으로 바꿉니다. -
<your_project_id>를 프로젝트 ID로 바꿉니다. 이는 프로젝트 개요 페이지에서 찾을 수 있습니다. -
<your_token>을 배포 토큰, 그룹 액세스 토큰, 프로젝트 액세스 토큰 또는 개인 액세스 토큰으로 바꿉니다.
package.json 파일에서 Yarn Classic에서는 범위 제외된 레지스트리가 작동하지 않습니다. 이는 다음 이슈에 근거합니다.
따라서 Yarn Classic의 경우 publishConfig 아래에 @scope:registry가 아니라 registry가 있어야 합니다.
GitLab 패키지 레지스트리로 명령줄이나 CI/CD 파이프라인을 통해 게시할 수 있습니다.
명령줄을 통한 게시 - 수동 게시
# Yarn 1 (Classic)
yarn publish
# Yarn 2+
yarn npm publish
이제 패키지가 패키지 레지스트리에 게시되어야 합니다.
CI/CD 파이프라인을 통한 게시 - 자동 게시
이 방법을 사용할 때는 파이프라인 변수를 사용할 수 있습니다.
인스턴스 러너 (기본) 또는 프라이빗 러너 (고급)을 사용할 수 있습니다.
인스턴스 러너
프로젝트나 그룹에 대한 인증 토큰을 생성하려면 다음 단계를 수행합니다.
- 왼쪽 사이드바에서 검색 또는 이동을 선택하고 프로젝트나 그룹을 찾습니다.
- 왼쪽 사이드바에서 설정 > 저장소 > 배포 토큰을 선택합니다.
-
read_package_registry와write_package_registry스코프로 배포 토큰을 생성하고 생성된 토큰을 복사합니다. - 왼쪽 사이드바에서 설정 > CI/CD > 변수를 선택합니다.
-
변수 추가를 선택하고 다음 설정을 사용합니다:
| 필드 | 값 |
|---|---|
| 키 | NPM_AUTH_TOKEN
|
| 값 | <단계 3에서 얻은 토큰>
|
| 타입 | 변수 |
| 보호된 변수 | 확인됨
|
| 마스크 변수 | 확인됨
|
| 변수 확장 | 확인됨
|
모든 보호된 변수를 사용하려면:
- Yarn 패키지 소스 코드를 포함하는 저장소로 이동합니다.
- 왼쪽 사이드바에서 설정 > 저장소를 선택합니다.
- 태그가 있는 브랜치에서 빌드하는 경우 보호된 태그를 선택하고 의미 있는 버전 설정을 위해
v*(와일드카드)를 추가합니다. - 태그가 없는 브랜치에서 빌드하는 경우 보호된 브랜치를 선택합니다.
- 태그가 있는 브랜치에서 빌드하는 경우 보호된 태그를 선택하고 의미 있는 버전 설정을 위해
그런 다음 .yarnrc.yml 구성에서 위에서 생성한 NPM_AUTH_TOKEN을 패키지 프로젝트 루트 디렉토리의 파일에 추가합니다. 해당 파일은 package.json이 있는 디렉토리에 있어야 합니다.
npmScopes:
esp-code:
npmPublishRegistry: "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/npm/"
npmAlwaysAuth: true
npmAuthToken: "${NPM_AUTH_TOKEN}"
프라이빗 러너
패키지 프로젝트 루트 디렉터리(여기에 package.json이 있음)의 .yarnrc.yml 구성에 CI_JOB_TOKEN을 추가하십시오:
npmScopes:
esp-code:
npmPublishRegistry: "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/packages/npm/"
npmAlwaysAuth: true
npmAuthToken: "${CI_JOB_TOKEN}"
CI/CD 파이프라인을 사용하여 패키지를 게시하려면 yarnrc.yml을 포함하는 GitLab 프로젝트에서 .gitlab-ci.yml 파일을 편집하거나 만드세요. 예를 들어, 태그 푸시에서만 트리거하도록 설정할 수 있습니다:
# Yarn 1
image: node:lts
stages:
- deploy
rules:
- if: $CI_COMMIT_TAG
deploy:
stage: deploy
script:
- yarn publish
# Yarn 2+
image: node:lts
stages:
- deploy
rules:
- if: $CI_COMMIT_TAG
deploy:
stage: deploy
before_script:
- corepack enable
- yarn set version stable
script:
- yarn npm publish
파이프라인 실행 시 패키지가 패키지 레지스트리에 게시됩니다.
패키지 설치
패키지를 설치하는 데 두 가지 API 엔드포인트를 사용할 수 있습니다:
-
인스턴스 수준: 조직 범위에서 많은 패키지와 작업할 때 가장 적합합니다.
-
인스턴스 수준에서 설치하는 경우 패키지를 범위로 지정해야 합니다. 범위를 가진 패키지는
@로 시작하고@owner/package-name형식을 갖습니다..yarnrc.yml파일과package.json의publishConfig옵션을 사용하여 패키지의 범위를 설정할 수 있습니다. -
@scope에 사용된 값은 패키지를 호스팅하는 조직 루트(최상위 프로젝트)...com/my-org(@my-org)로, 패키지 소스 코드가 있는 프로젝트의 루트가 아닙니다. - 범위는 항상 소문자여야 합니다.
-
패키지 이름은
@my-org/any-name과 같이 할 수 있습니다. - 프로젝트 수준: 일회성 패키지를 가지고 있는 경우입니다.
프로젝트 수준에서 설치할 계획이라면 네이밍 컨벤션을 따를 필요가 없습니다.
| 프로젝트 URL | 패키지 레지스트리 | 조직 범위 | 전체 패키지 이름 |
|---|---|---|---|
https://gitlab.com/<my-org>/<group-name>/<package-name-example>
| Package Name Example | @my-org
| @my-org/package-name
|
https://gitlab.com/<example-org>/<group-name>/<project-name>
| Project Name | @example-org
| @example-org/project-name
|
인스턴스 수준 또는 프로젝트 수준에서 설치할 수 있습니다.
.yarnrc.yml의 구성은 패키지를 사용하는 프로젝트 루트마다 추가할 수 있거나 시스템 사용자 홈 디렉터리에 있는 전역 구성을 사용할 수 있습니다.
인스턴스 수준에서 설치
다음은 .yarnrc.yml 파일에서 전역 구성을 위한 단계입니다:
조직 범위 구성
npmScopes:
<my-org>:
npmRegistryServer: "https://<your_domain_name>/api/v4/packages/npm"
-
<my-org>을@기호를 제외한 프로젝트의 루트 레벨 그룹으로 대체하십시오. -
<your_domain_name>을 도메인 이름으로 대체하십시오. 예를 들어,gitlab.com.
레지스트리 설정
패키지가 공개가 아닌 경우 이 단계를 건너뜁니다.
npmRegistries:
//<your_domain_name>/api/v4/packages/npm:
npmAlwaysAuth: true
npmAuthToken: "<your_token>"
-
<your_domain_name>을 도메인 이름으로 대체하십시오. 예를 들어,gitlab.com. -
<your_token>을 배포 토큰(권장), 그룹 액세스 토큰, 프로젝트 액세스 토큰 또는 개인 액세스 토큰으로 대체하십시오.
프로젝트 수준에서 설치
다음은 .yarnrc.yml 파일에서 각 프로젝트에 대한 단계입니다:
프로젝트 범위 구성
npmScopes:
<my-org>:
npmRegistryServer: "https://<your_domain_name>/api/v4/projects/<your_project_id>/packages/npm"
-
<my-org>을@기호를 제외한 프로젝트의 루트 레벨 그룹으로 대체하십시오. -
<your_domain_name>을 도메인 이름으로 대체하십시오. 예를 들어,gitlab.com. -
<your_project_id>을 프로젝트 개요 페이지에서 찾을 수 있는 프로젝트 ID로 대체하십시오.
레지스트리 설정(프로젝트 레벨)
만약 여러분의 패키지가 공개(public)이고 비공개(private)가 아니라면, 이 단계를 건너뛰세요.
npmRegistries:
//<your_domain_name>/api/v4/projects/<your_project_id>/packages/npm:
npmAlwaysAuth: true
npmAuthToken: "<your_token>"
-
<your_domain_name>을 여러분의 도메인 이름(예:gitlab.com)으로 대체하세요. -
<your_token>을 배포 토큰(권장), 그룹 액세스 토큰, 프로젝트 액세스 토큰 또는 개인 액세스 토큰으로 대체하세요. -
<your_project_id>를 프로젝트 개요 페이지에서 찾을 수 있는 프로젝트 ID로 대체하세요.
패키지 설치
Yarn 2+를 사용하는 경우, 패키지를 설치하려면 명령줄이나 CI/CD 파이프라인에서 yarn add를 사용하세요:
yarn add @scope/my-package
Yarn Classic인 경우
Yarn Classic 설정은 .npmrc와 .yarnrc 파일 둘 다가 필요합니다.
이슈에서 언급된 대로입니다:
-
.npmrc파일에 자격 증명을 배치하세요. -
.yarnrc파일에 범위 지정된 레지스트리를 배치하세요.
# .npmrc
//<your_domain_name>/api/v4/projects/<your_project_id>/packages/npm/:_authToken="<your_token>"
# .yarnrc
"@scope:registry" "https://<your_domain_name>/api/v4/projects/<your_project_id>/packages/npm/"
그럼 yarn add를 사용하여 패키지를 설치할 수 있습니다.
관련 주제
문제 해결
npm 레지스트리용 Yarn 실행 오류
Yarn을 npm 레지스트리와 함께 사용하는 경우 다음과 같은 오류 메시지가 표시될 수 있습니다:
yarn install v1.15.2
warning package.json: No license field
info No lockfile found.
warning XXX: No license field
[1/4] 🔍 Resolving packages...
[2/4] 🚚 Fetching packages...
error An unexpected error occurred: "https://gitlab.example.com/api/v4/projects/XXX/packages/npm/XXX/XXX/-/XXX/XXX-X.X.X.tgz: Request failed \"404 Not Found\"".
info If you think this is a bug, please open a bug report with the information provided in "/Users/XXX/gitlab-migration/module-util/yarn-error.log".
info Visit https://classic.yarnpkg.com/en/docs/cli/install for documentation about this command
이 경우, 다음 명령어는 현재 디렉토리에 .yarnrc라는 파일을 생성합니다. 전역 구성을 위해 사용자 홈 디렉토리 또는 프로젝트 루트를 위해 프로젝트 별 구성을 위해 확인하세요:
yarn config set '//gitlab.example.com/api/v4/projects/<your_project_id>/packages/npm/:_authToken' "<your_token>"
yarn config set '//gitlab.example.com/api/v4/packages/npm/:_authToken' "<your_token>"
도움말