debian-mirror-gitlab/doc/user/packages/workflows/project_registry.md

90 lines
4.8 KiB
Markdown
Raw Normal View History

2020-10-24 23:57:45 +05:30
---
stage: Package
group: Package
2021-02-22 17:27:13 +05:30
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
2020-10-24 23:57:45 +05:30
---
2021-04-29 21:17:54 +05:30
# Store all of your packages in one GitLab project **(FREE)**
2020-03-13 15:44:24 +05:30
2021-02-22 17:27:13 +05:30
You can store all of your packages in one project's Package Registry. Rather than using
a GitLab repository to store code, you can use the repository to store all your packages.
Then you can configure your remote repositories to point to the project in GitLab.
2020-03-13 15:44:24 +05:30
2021-02-22 17:27:13 +05:30
You might want to do this because:
2020-03-13 15:44:24 +05:30
2021-02-22 17:27:13 +05:30
- You want to publish your packages in GitLab, but to a different project from where your code is stored.
2021-03-11 19:13:27 +05:30
- You want to group packages together in one project. For example, you might want to put all npm packages,
2021-02-22 17:27:13 +05:30
or all packages for a specific department, or all private packages in the same project.
- When you install packages for other projects, you want to use one remote.
- You want to migrate your packages from a third-party package registry to a single place in GitLab and do not
want to worry about setting up separate projects for each package.
- You want to have your CI/CD pipelines build all of your packages to one project, so the person responsible for
validating packages can manage them all in one place.
2020-03-13 15:44:24 +05:30
## Example walkthrough
2021-02-22 17:27:13 +05:30
No functionality is specific to this feature. Instead, we're taking advantage of the functionality
of each package management system to publish different package types to the same place.
2020-03-13 15:44:24 +05:30
2021-02-22 17:27:13 +05:30
- <i class="fa fa-youtube-play youtube" aria-hidden="true"></i>
2021-03-11 19:13:27 +05:30
Watch a video of how to add Maven, npm, and Conan packages to [the same project](https://youtu.be/ui2nNBwN35c).
2021-02-22 17:27:13 +05:30
- [View an example project](https://gitlab.com/sabrams/my-package-registry/-/packages).
2020-03-13 15:44:24 +05:30
2021-02-22 17:27:13 +05:30
## Store different package types in one GitLab project
2020-03-13 15:44:24 +05:30
2021-02-22 17:27:13 +05:30
Let's take a look at how you might create a public place to hold all of your public packages.
2020-03-13 15:44:24 +05:30
2021-02-22 17:27:13 +05:30
1. Create a new project in GitLab. The project doesn't require any code or content. Note the project ID
that's displayed on the project overview page.
1. Create an access token. All package types in the Package Registry are accessible by using
[GitLab personal access tokens](../../profile/personal_access_tokens.md).
If you're using CI/CD, you can use CI job tokens (`CI_JOB_TOKEN`) to authenticate.
1. Configure your local project and publish the package.
2020-03-13 15:44:24 +05:30
2021-02-22 17:27:13 +05:30
You can upload all types of packages to the same project, or
split things up based on package type or package visibility level.
2020-03-13 15:44:24 +05:30
2021-03-11 19:13:27 +05:30
### npm
2020-03-13 15:44:24 +05:30
2021-03-11 19:13:27 +05:30
If you're using npm, create an `.npmrc` file. Add the appropriate URL for publishing
2021-02-22 17:27:13 +05:30
packages to your project. Finally, add a section to your `package.json` file.
2020-03-13 15:44:24 +05:30
2021-02-22 17:27:13 +05:30
Follow the instructions in the
2021-03-11 19:13:27 +05:30
[GitLab Package Registry npm documentation](../npm_registry/index.md#authenticate-to-the-package-registry). After
you do this, you can publish your npm package to your project using `npm publish`, as described in the
2021-02-22 17:27:13 +05:30
[publishing packages](../npm_registry/index.md#publish-an-npm-package) section.
2020-03-13 15:44:24 +05:30
2021-02-22 17:27:13 +05:30
### Maven
2020-03-13 15:44:24 +05:30
2021-02-22 17:27:13 +05:30
If you are using Maven, you update your `pom.xml` file with distribution sections. These updates include the
2020-03-13 15:44:24 +05:30
appropriate URL for your project, as described in the [GitLab Maven Repository documentation](../maven_repository/index.md#project-level-maven-endpoint).
2021-01-29 00:20:46 +05:30
Then, you need to add a `settings.xml` file and [include your access token](../maven_repository/index.md#authenticate-with-a-personal-access-token-in-maven).
2021-02-22 17:27:13 +05:30
Now you can [publish Maven packages](../maven_repository/index.md#publish-a-package) to your project.
### Conan
2020-03-13 15:44:24 +05:30
2021-02-22 17:27:13 +05:30
For Conan, you need to add GitLab as a Conan registry remote. Follow the instructions in the
[GitLab Conan Repository docs](../conan_repository/index.md#add-the-package-registry-as-a-conan-remote).
Then, create your package using the plus-separated (`+`) project path as your Conan user. For example,
if your project is located at `https://gitlab.com/foo/bar/my-proj`,
[create your Conan package](../conan_repository/index.md) using `conan create . foo+bar+my-proj/channel`.
2021-03-08 18:12:59 +05:30
`channel` is your package channel (such as `stable` or `beta`).
2020-03-13 15:44:24 +05:30
2021-02-22 17:27:13 +05:30
After you create your package, you're ready to [publish your package](../conan_repository/index.md#publish-a-conan-package),
depending on your final package recipe. For example:
2020-03-13 15:44:24 +05:30
```shell
CONAN_LOGIN_USERNAME=<gitlab-username> CONAN_PASSWORD=<personal_access_token> conan upload MyPackage/1.0.0@foo+bar+my-proj/channel --all --remote=gitlab
```
2020-11-24 15:15:51 +05:30
2021-04-17 20:07:23 +05:30
### Composer
You can't publish a Composer package outside of its project. An [issue](https://gitlab.com/gitlab-org/gitlab/-/issues/250633)
exists to implement functionality that allows you to publish such packages to other projects.
2021-02-22 17:27:13 +05:30
### All other package types
2020-11-24 15:15:51 +05:30
2021-02-22 17:27:13 +05:30
[All package types supported by GitLab](../index.md) can be published in
the same GitLab project. In previous releases, not all package types could
be published in the same project.