Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2023-09-11 21:13:14 +0300
committerGitLab Bot <gitlab-bot@gitlab.com>2023-09-11 21:13:14 +0300
commit9e40efa6a6cb39c0a4a6d7d43f7445e2d6e25172 (patch)
tree3b5db6c0284b8c37d6afcae4e1340c3fe57c90f9 /doc/ci/components
parentd06e4d855aed9148571c7fd95fe02f208a017dd3 (diff)
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/ci/components')
-rw-r--r--doc/ci/components/index.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/doc/ci/components/index.md b/doc/ci/components/index.md
index a5712a271ca..d4ed98893af 100644
--- a/doc/ci/components/index.md
+++ b/doc/ci/components/index.md
@@ -116,6 +116,9 @@ namespace named `my-username`:
└── .gitlab-ci.yml
```
+ The `.gitlab-ci.yml` file is not required for a CI/CD component to work, but [testing the component](#test-a-component)
+ in a pipeline in the project is recommended.
+
This component is referenced with the path `gitlab.com/my-username/my-component@<version>`.
- Containing one default component and multiple sub-components, then the file structure
@@ -153,9 +156,9 @@ Nesting of components is not possible. For example:
### Test a component
-Testing components as part of the development workflow to ensure that quality maintains high standards is strongly recommended.
+Testing CI/CD components as part of the development workflow is strongly recommended and helps ensure consistent behavior.
-Testing changes in a CI/CD pipeline can be done, like any other project, by creating a `.gitlab-ci.yml` in the root directory.
+Test changes in a CI/CD pipeline like any other project, by creating a `.gitlab-ci.yml` file in the root directory of the component repository.
For example:
@@ -199,12 +202,17 @@ After committing and pushing changes, the pipeline tests the component then rele
### Release a component
-Component repositories are released using the [`release`](../yaml/index.md#release) keyword within a CI pipeline.
+To create a release for a CI/CD component, you can use:
+
+- The [`release`](../yaml/index.md#release) keyword in a CI/CD pipeline.
+- The [UI for creating a release](../../user/project/releases/index.md#create-a-release).
Like in the [example above](#test-a-component), after all tests pass in a pipeline running for a tag ref, we can release a new version of the components repository.
All released versions of the components repository are displayed in the Components Catalog page for the given resource, providing users with information about official releases.
+Components [can be used](#use-a-component-in-a-cicd-configuration) without being released, but only with a commit SHA or a branch name. To enable the use of tags or the `~latest` version keyword, you must create a release.
+
### Use a component in a CI/CD configuration
A pipeline component is identified by a unique address in the form `<fully-qualified-doman-name>/<component-path>@<version>`
@@ -313,7 +321,7 @@ include:
stages: [verify, deploy]
##
-# inside the component YAML:
+# inside the component's template.yml file:
spec:
inputs:
stage: