GitLab Composer Repository · Gitlab 中文文檔

# GitLab Composer Repository > 原文：[https://docs.gitlab.com/ee/user/packages/composer_repository/](https://docs.gitlab.com/ee/user/packages/composer_repository/) * [Enabling the Composer Repository](#enabling-the-composer-repository) * [Getting started](#getting-started) * [Creating a package project](#creating-a-package-project) * [Publishing the package](#publishing-the-package) * [Installing a package](#installing-a-package) # GitLab Composer Repository[](#gitlab-composer-repository-premium "Permalink") [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/15886) in [GitLab Premium](https://about.gitlab.com/pricing/) 13.2. 使用 GitLab Composer 信息庫，每個項目都可以有自己的空間來存儲[Composer](https://s0getcomposer0org.icopy.site/)軟件包. ## Enabling the Composer Repository[](#enabling-the-composer-repository "Permalink") **注意：**僅當您的 GitLab 管理員[啟用了對 Package Registry 的支持時，](../../../administration/packages/index.html)此選項才可用. 啟用 Composer 信息庫后，默認情況下它將可用于所有新項目. 要為現有項目啟用它，或者要禁用它： 1. 導航到項目的**"設置">"常規">"可見性，項目功能，權限"** . 2. 找到"軟件包"功能并啟用或禁用它. 3. 單擊**保存更改**以使更改生效. 然后，您應該能夠在左側欄中看到" **程序包和注冊表"**部分. ## Getting started[](#getting-started "Permalink") 本節將介紹如何創建一個新的示例 Composer 軟件包進行發布. 這是測試**GitLab Composer 注冊表**的快速入門. 您將需要最新版本的[Composer](https://s0getcomposer0org.icopy.site/) . ### Creating a package project[](#creating-a-package-project "Permalink") 了解如何創建完整的 Composer 項目不在本指南的范圍內，但是您可以創建一個小程序包來測試注冊表. 首先創建一個名為`my-composer-package`的新目錄： ``` mkdir my-composer-package && cd my-composer-package ``` 在此目錄中創建一個新的`composer.json`文件以設置基本項目： ``` touch composer.json ``` 在`composer.json`內部，添加以下代碼： ``` { "name": "<namespace>/composer-test", "type": "library", "license": "GPL-3.0-only", "version": "1.0.0" } ``` 將`<namespace>`替換為唯一的命名空間，例如您的 GitLab 用戶名或組名. 在創建了基本的包結構之后，我們需要在 Git 中對其進行標記并將其推送到存儲庫中. ``` git init git add composer.json git commit -m 'Composer package test' git tag v1.0.0 git add origin git@gitlab.com:<namespace>/<project-name>.git git push origin v1.0.0 ``` ### Publishing the package[](#publishing-the-package "Permalink") 現在，我們的項目基礎已經完成，我們可以發布該軟件包了. 為此，您將需要以下內容： * 個人訪問令牌. 您可以生成范圍設置為`api`的[個人訪問令牌](../../../user/profile/personal_access_tokens.html) ，以進行存儲庫身份驗證. * 您的項目 ID，可以在項目的主頁上找到. 要發布托管在 GitLab 上的軟件包，我們需要使用`curl`這樣的工具對 GitLab 軟件包 API 進行`POST` ： ``` curl --data tag=<tag> 'https://__token__:<personal-access-token>@gitlab.com/api/v4/projects/<project_id>/packages/composer' ``` Where: * `<personal-access-token>`是您的個人訪問令牌. * `<project_id>`是您的項目 ID. * `<tag>`是您要發布的版本的 Git 標記名稱. 在此示例中，它應為`v1.0.0` . 請注意，除了使用`tag=<tag>`您還可以使用`branch=<branch>`來發布分支. 如果上面的命令成功執行，您現在應該可以在項目頁面的" **程序包和注冊表"**部分下看到該程序包. ### Installing a package[](#installing-a-package "Permalink") 要安裝您的軟件包，您需要： * 個人訪問令牌. 您可以生成范圍設置為`api`的[個人訪問令牌](../../../user/profile/personal_access_tokens.html) ，以進行存儲庫身份驗證. * 您的組 ID，可在項目組的主頁上找到. 將 GitLab Composer 軟件包存儲庫以及要安裝的軟件包名稱和版本添加到現有項目的`composer.json`文件中，如下所示： ``` { ... "repositories": [ { "type": "composer", "url": "https://gitlab.com/api/v4/group/<group_id>/-/packages/composer/packages.json" } ], "require": { ... "<package_name>": "<version>" }, ... } ``` Where: * `<group_id>`是在項目的"組"頁面下找到的組 ID. * `<package_name>`是軟件包的`composer.json`文件中定義的軟件包名稱. * `<version>`是您的軟件包版本（在此示例中為`1.0.0` ）. 您還需要使用 GitLab 憑據創建一個`auth.json`文件： ``` { "http-basic": { "gitlab.com": { "username": "___token___", "password": "<personal_access_token>" } } } ``` Where: * `<personal_access_token>`是您的個人訪問令牌. 配置了`composer.json`和`auth.json`文件后，您可以通過運行`composer`安裝軟件包： ``` composer update ``` 如果成功，您應該能夠看到指示軟件包已成功安裝的輸出. **重要提示：**請確保不要將`auth.json`文件提交到您的存儲庫. 要從 CI 作業安裝軟件包，請考慮將[`composer config`](https://s0getcomposer0org.icopy.site/doc/articles/handling-private-packages-with-satis.md)工具與您的個人訪問令牌一起使用，并將其存儲在[GitLab CI / CD 環境變量](../../../ci/variables/README.html)或[Hashicorp Vault 中](../../../ci/examples/authenticating-with-hashicorp-vault/index.html) .