diff options
Diffstat (limited to 'doc/ci/components/catalog.md')
| -rw-r--r-- | doc/ci/components/catalog.md | 28 |
1 files changed, 9 insertions, 19 deletions
diff --git a/doc/ci/components/catalog.md b/doc/ci/components/catalog.md index 3a3f63365bb..12e795073b7 100644 --- a/doc/ci/components/catalog.md +++ b/doc/ci/components/catalog.md @@ -6,17 +6,18 @@ info: To determine the technical writer assigned to the Stage/Group associated w # CI/CD Catalog **(PREMIUM ALL EXPERIMENT)** +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/407249) in GitLab 16.1. + The CI/CD Catalog is a list of [components repositories](index.md#components-repository), each containing resources that you can add to your CI/CD pipelines. -## Mark the project as a catalog resource - -> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/407249) in GitLab 16.1. +## Mark a components repository as a catalog resource -After components are added to a components repository, they can immediately be [used](index.md#use-a-component-in-a-cicd-configuration) to build pipelines in other projects. +After components are added to a components repository, they can immediately be [used](index.md#use-a-component-in-a-cicd-configuration) +to build pipelines in other projects. -However, this repository is not discoverable. You must mark this project as a catalog resource to allow it to be visible in the CI Catalog -so other users can discover it. +However, this repository is not discoverable. You must mark this project as a catalog resource +to allow it to be visible in the CI/CD Catalog so other users can discover it. To mark a project as a catalog resource: @@ -25,19 +26,8 @@ To mark a project as a catalog resource: 1. Expand **Visibility, project features, permissions**. 1. Scroll down to **CI/CD Catalog resource** and select the toggle to mark the project as a catalog resource. -On the left sidebar, select **Search or go to** and find your project. +Ensure the project has a clear [description](../../user/project/settings/index.md#edit-project-name-and-description), +as the project description is displayed in the component list in the catalog. NOTE: This action is not reversible. - -## Convert a CI template to component - -Any existing CI template, that you share with other projects via `include:` syntax, can be converted to a CI component. - -1. Decide whether you want the component to be part of an existing [components repository](index.md#components-repository), - if you want to logically group components together. Create and setup a [components repository](index.md#components-repository) otherwise. -1. Create a YAML file in the components repository according to the expected [directory structure](index.md#directory-structure). -1. Copy the content of the template YAML file into the new component YAML file. -1. Refactor the component YAML to follow the [best practices](index.md#best-practices) for components. -1. Leverage the `.gitlab-ci.yml` in the components repository to [test changes to the component](index.md#test-a-component). -1. Tag and [release the component](index.md#release-a-component). |