Ambiguity of "GitLab CI/CD Workflow"
Problem
Today, we mention "GitLab CI/CD Workflow" in many places in documentation, however, they refer different things - either feature A, feature B or just a concept. Therefore, it's confusing for users that the terminology can be interpreted in many different ways. It's documented in !101894 (diffs) that Ubiquitous Language is important to build universally understandable products in monolithic codebase, otherwise it will negatively impact our development that causes bugs and inconsistency due to its fragility.
GitLab CI/CD Workflow
Features can be interpreted as -
workflow
keyword in.gitlab-ci.yml
- https://docs.gitlab.com/ee/ci/yaml/workflow.html -
ci_access
in GitLab Agent https://docs.gitlab.com/ee/user/clusters/agent/ci_cd_workflow.html -
GitLab CI Events (#363384 - closed)
- To be implemented
GitLab CI/CD Workflow
Concepts can be interpreted as
The references in documentation
shinya@shinya-B550-VISION-D:~/workspace/thin-gdk/services/rails/src$ grep -R 'CI/CD workflow' ./doc
./doc/user/clusters/agent/index.md:### GitLab CI/CD workflow
./doc/user/clusters/agent/index.md:- [GitLab CI/CD workflow](ci_cd_workflow.md)
./doc/user/clusters/agent/ci_cd_workflow.md:> - [Renamed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/80508) from _CI/CD tunnel_ to _CI/CD workflow_ in GitLab 14.9.
./doc/user/clusters/agent/ci_cd_workflow.md:You can use a GitLab CI/CD workflow to safely deploy to and update your Kubernetes clusters.
./doc/user/clusters/agent/ci_cd_workflow.md:The CI/CD workflow requires runners to be registered with GitLab, but these runners do not have to be in the cluster where the agent is.
./doc/user/clusters/agent/ci_cd_workflow.md:## GitLab CI/CD workflow steps
./doc/user/clusters/agent/install/index.md:- You use [a GitLab CI/CD workflow](../ci_cd_workflow.md#gitlab-cicd-workflow-steps) and want to authorize a different project to use the agent.
./doc/user/clusters/agent/install/index.md:- For a [GitLab CI/CD workflow](../ci_cd_workflow.md), ensure that
./doc/user/clusters/agent/install/index.md:- For a GitLab CI/CD workflow, [authorize the agent to access your projects](../ci_cd_workflow.md#authorize-the-agent). Then
./doc/user/clusters/agent/install/index.md:- [Auto DevOps setup that uses the CI/CD workflow](https://gitlab.com/gitlab-examples/ops/gitops-demo/hello-world-service)
./doc/user/clusters/agent/install/index.md:- [Cluster management project template example that uses the CI/CD workflow](https://gitlab.com/gitlab-examples/ops/gitops-demo/cluster-management)
./doc/user/application_security/dast_api/index.md:you can run DAST API tests as part your CI/CD workflow.
./doc/user/application_security/api_fuzzing/index.md:you can run fuzz tests as part your CI/CD workflow.
./doc/user/application_security/coverage_fuzzing/index.md:you can run your coverage-guided fuzz testing as part your CI/CD workflow.
./doc/user/infrastructure/clusters/migrate_to_gitlab_agent.md:- [A GitLab CI/CD workflow](../../clusters/agent/ci_cd_workflow.md).
./doc/user/infrastructure/clusters/migrate_to_gitlab_agent.md:you can use the [CI/CD workflow](../../clusters/agent/ci_cd_workflow.md).
./doc/user/infrastructure/clusters/migrate_to_gitlab_agent.md:Follow the process for the [CI/CD workflow](../../clusters/agent/ci_cd_workflow.md).
./doc/user/project/clusters/deploy_to_cluster.md:To deploy with the agent, use the [CI/CD workflow](../../clusters/agent/ci_cd_workflow.md).
./doc/ci/introduction/index.md:### GitLab CI/CD workflow
./doc/ci/introduction/index.md:### A deeper look into the CI/CD workflow
./doc/ci/introduction/index.md:![Deeper look into the basic CI/CD workflow](img/gitlab_workflow_example_extended_v12_3.png)
./doc/ci/cloud_services/index.md:- Subject or `sub`: A concatenation of metadata describing the GitLab CI/CD workflow including the group, project, branch, and tag. The `sub` field is in the following format:
./doc/ci/docker/index.md:There are two primary ways to incorporate [Docker](https://www.docker.com) into your CI/CD workflow:
./doc/development/cicd/templates.md:A **pipeline template** provides an end-to-end CI/CD workflow that matches a project's
Current Proposal - 2022-11-14
- Issue to re-write docs for CI/CD Workflow associated with the agent.
- Issue to come up with new name for "ci workflow"
Edited by James Heimbuck