diff options
Diffstat (limited to 'doc/development/cicd')
| -rw-r--r-- | doc/development/cicd/cicd_reference_documentation_guide.md | 2 | ||||
| -rw-r--r-- | doc/development/cicd/cicd_tables.md | 2 | ||||
| -rw-r--r-- | doc/development/cicd/index.md | 5 | ||||
| -rw-r--r-- | doc/development/cicd/pipeline_wizard.md | 5 | ||||
| -rw-r--r-- | doc/development/cicd/schema.md | 3 | ||||
| -rw-r--r-- | doc/development/cicd/templates.md | 20 |
6 files changed, 22 insertions, 15 deletions
diff --git a/doc/development/cicd/cicd_reference_documentation_guide.md b/doc/development/cicd/cicd_reference_documentation_guide.md index e358b24c60f..ccd952f586c 100644 --- a/doc/development/cicd/cicd_reference_documentation_guide.md +++ b/doc/development/cicd/cicd_reference_documentation_guide.md @@ -1,7 +1,7 @@ --- stage: Verify group: Pipeline Authoring -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +info: Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/ee/development/development_processes.html#development-guidelines-review. --- # Documenting the `.gitlab-ci.yml` keywords diff --git a/doc/development/cicd/cicd_tables.md b/doc/development/cicd/cicd_tables.md index 8cfb0faca00..465597ca455 100644 --- a/doc/development/cicd/cicd_tables.md +++ b/doc/development/cicd/cicd_tables.md @@ -1,7 +1,7 @@ --- stage: Verify group: Pipeline Execution -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +info: Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/ee/development/development_processes.html#development-guidelines-review. --- # Add new tables to the CI database diff --git a/doc/development/cicd/index.md b/doc/development/cicd/index.md index 41ae4fe14b4..18781f9315a 100644 --- a/doc/development/cicd/index.md +++ b/doc/development/cicd/index.md @@ -1,15 +1,14 @@ --- stage: Verify group: Pipeline Execution -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments -type: index, concepts, howto +info: Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/ee/development/development_processes.html#development-guidelines-review. --- # CI/CD development guidelines Development guides that are specific to CI/CD are listed here: -- If you are creating new CI/CD templates, please read [the development guide for GitLab CI/CD templates](templates.md). +- If you are creating new CI/CD templates, read [the development guide for GitLab CI/CD templates](templates.md). - If you are adding a new keyword or changing the CI schema, check the [CI schema guide](schema.md) See the [CI/CD YAML reference documentation guide](cicd_reference_documentation_guide.md) diff --git a/doc/development/cicd/pipeline_wizard.md b/doc/development/cicd/pipeline_wizard.md index f322ec2e2bf..0c0c0f3cc45 100644 --- a/doc/development/cicd/pipeline_wizard.md +++ b/doc/development/cicd/pipeline_wizard.md @@ -1,7 +1,7 @@ --- stage: none group: Incubation Engineering -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +info: Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/ee/development/development_processes.html#development-guidelines-review. --- # Pipeline Wizard @@ -133,8 +133,7 @@ is planned to add the ability to create a MR from here. should be committed to - `default-branch` (required): The branch that will be pre-selected during the commit step. This can be changed by the user. -- `default-filename` (optional, default: `.gitlab-ci.yml`): The Filename - to be used for the file. This can be overridden in the template file. +- `default-filename` (optional, default: `.gitlab-ci.yml`): The file name to be used for the file. This can be overridden in the template file. ### Events diff --git a/doc/development/cicd/schema.md b/doc/development/cicd/schema.md index 26e63fb53d8..e9a0b93b5f3 100644 --- a/doc/development/cicd/schema.md +++ b/doc/development/cicd/schema.md @@ -1,8 +1,7 @@ --- stage: Verify group: Pipeline Authoring -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments -type: index, howto +info: Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/ee/development/development_processes.html#development-guidelines-review. --- # Contribute to the CI/CD Schema diff --git a/doc/development/cicd/templates.md b/doc/development/cicd/templates.md index f977a70ac05..a2b490b9106 100644 --- a/doc/development/cicd/templates.md +++ b/doc/development/cicd/templates.md @@ -1,12 +1,22 @@ --- stage: Verify group: Pipeline Authoring -info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments -type: index, concepts, howto +info: Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/ee/development/development_processes.html#development-guidelines-review. --- # Development guide for GitLab CI/CD templates +NOTE: +With the introduction of the [CI/CD Catalog](../../ci/components/index.md#cicd-catalog), +GitLab is no longer accepting contributions of new CI/CD templates to the codebase. Instead, +we encourage team members to create [CI/CD components](../../ci/components/index.md) +for the catalog. This transition enhances the modularity and maintainability of our +shared CI/CD resources, and avoids the complexities of contributing new CI/CD templates. +If you need to update an existing template, you must also update the matching CI/CD component. +If no component exists that matches the CI/CD template yet, consider creating the matching component. +This ensures that template and component functionality remain in sync, aligning with +our new development practices. + This document explains how to develop [GitLab CI/CD templates](../../ci/examples/index.md#cicd-templates). ## Requirements for CI/CD templates @@ -285,7 +295,7 @@ the user's `.gitlab-ci.yml` immediately causes a lint error because there are no such jobs named `performance` in the included template anymore. Therefore, users have to fix their `.gitlab-ci.yml` that could annoy their workflow. -Please read [versioning](#versioning) section for introducing breaking change safely. +Read [versioning](#versioning) section for introducing breaking change safely. ## Versioning @@ -378,7 +388,7 @@ Each CI/CD template must be tested to make sure that it's safe to be published. ### Manual QA It's always good practice to test the template in a minimal demo project. -To do so, please follow the following steps: +To do so, follow the following steps: 1. Create a public sample project on <https://gitlab.com>. 1. Add a `.gitlab-ci.yml` to the project with the proposed template. @@ -482,6 +492,6 @@ If you're unsure if it's secure or not, you must ask security experts for cross- After your CI/CD template MR is created and labeled with `ci::templates`, DangerBot suggests one reviewer and one maintainer that can review your code. When your merge -request is ready for review, please [mention](../../user/discussions/index.md#mentions) +request is ready for review, [mention](../../user/discussions/index.md#mentions) the reviewer and ask them to review your CI/CD template changes. See details in the merge request that added [a DangerBot task for CI/CD template MRs](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/44688). |