diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-07 21:07:33 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-07 21:07:33 +0300 |
commit | 1bdc6c89c32a7380a81598629b9ad05ba9a2a94f (patch) | |
tree | 778f1dc16130b3138ab3b641e664038648046a40 /doc/ci/components | |
parent | 9a940dabf04df126e7978c0ab4b8770b86dcaaa8 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/ci/components')
-rw-r--r-- | doc/ci/components/index.md | 59 |
1 files changed, 0 insertions, 59 deletions
diff --git a/doc/ci/components/index.md b/doc/ci/components/index.md index 6c63cf2109a..6f1365561dc 100644 --- a/doc/ci/components/index.md +++ b/doc/ci/components/index.md @@ -92,65 +92,6 @@ In this example: - The `all-scans` component configuration is defined in a single file. - The `secret-detection` component configuration contains multiple files in a directory. -#### Component configurations saved in any directory (deprecated) - -WARNING: -Saving components through the following directory structure is [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/415855) and should be avoided. - -Components configurations can be saved through the following directory structure, containing: - -- `template.yml`: The component configuration, one file per component. If there is - only one component, this file can be in the root of the project. If there are multiple - components, each file must be in a separate subdirectory. -- `README.md`: A documentation file explaining the details of all the components in the repository. - -For example, if the project is on GitLab.com, named `my-project`, and in a personal -namespace named `my-namespace`: - -- Containing a single component and a simple pipeline to test the component, then - the file structure might be: - - ```plaintext - ├── template.yml - ├── README.md - └── .gitlab-ci.yml - ``` - - This component is referenced with the path `gitlab.com/my-namespace/my-project@<version>`. - -- Containing one default component and multiple sub-components, then the file structure - might be: - - ```plaintext - ├── template.yml - ├── README.md - ├── .gitlab-ci.yml - ├── unit/ - │ └── template.yml - └── integration/ - └── template.yml - ``` - - These components are identified by these paths: - - - `gitlab.com/my-namespace/my-project` - - `gitlab.com/my-namespace/my-project/unit` - - `gitlab.com/my-namespace/my-project/integration` - -It is possible to have a components repository with no default component, by having -no `template.yml` in the root directory. - -**Additional notes:** - -Nesting of components is not possible. For example: - -```plaintext -├── unit/ -│ └── template.yml -│ └── another_folder/ -│ └── nested_template.yml -``` - ## Use a component You can use a component in a CI/CD configuration with the `include: component` keyword. |