url stringlengths 24 122 | repo_url stringlengths 60 156 | date_extracted stringdate 2025-08-13 00:00:00 2025-08-13 00:00:00 | root stringlengths 3 85 | breadcrumbs listlengths 1 6 | filename stringlengths 6 60 | stage stringclasses 33
values | group stringclasses 81
values | info stringclasses 22
values | title stringlengths 3 110 ⌀ | description stringlengths 11 359 ⌀ | clean_text stringlengths 47 3.32M | rich_text stringlengths 321 3.32M |
|---|---|---|---|---|---|---|---|---|---|---|---|---|
https://docs.gitlab.com/development/internal_analytics/service_ping | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/internal_analytics/_index.md | 2025-08-13 | doc/development/internal_analytics/service_ping | [
"doc",
"development",
"internal_analytics",
"service_ping"
] | _index.md | Monitor | Analytics Instrumentation | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Service Ping development guidelines | null |
Service Ping is a GitLab process that collects and sends a weekly payload to GitLab.
The payload provides important high-level data that helps our product, support,
and sales teams understand how GitLab is used. The data helps to:
- Compare counts month over month (or week over week) to get a rough sense for how an ... | ---
stage: Monitor
group: Analytics Instrumentation
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Service Ping development guidelines
breadcrumbs:
- doc
- development... |
https://docs.gitlab.com/development/rails_request | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/rails_request.md | 2025-08-13 | doc/development/application_slis | [
"doc",
"development",
"application_slis"
] | rails_request.md | Platforms | Scalability | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Rails request SLIs (service level indicators) | null |
{{< alert type="note" >}}
This SLI is used for service monitoring. But not for [error budgets for stage groups](../stage_group_observability/_index.md#error-budget)
by default.
{{< /alert >}}
The request Apdex SLI and the error rate SLI are [SLIs defined in the application](_index.md).
The request Apdex measures ... | ---
stage: Platforms
group: Scalability
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Rails request SLIs (service level indicators)
breadcrumbs:
- doc
- development
-... |
https://docs.gitlab.com/development/application_slis | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/application_slis | [
"doc",
"development",
"application_slis"
] | _index.md | Platforms | Scalability | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | GitLab Application Service Level Indicators (SLIs) | null |
It is possible to define [Service Level Indicators(SLIs)](https://en.wikipedia.org/wiki/Service_level_indicator)
directly in the Ruby codebase. This keeps the definition of operations
and their success close to the implementation and allows the people
building features to easily define how these features should be
mo... | ---
stage: Platforms
group: Scalability
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: GitLab Application Service Level Indicators (SLIs)
breadcrumbs:
- doc
- developm... |
https://docs.gitlab.com/development/sidekiq_execution | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/sidekiq_execution.md | 2025-08-13 | doc/development/application_slis | [
"doc",
"development",
"application_slis"
] | sidekiq_execution.md | Platforms | Scalability | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Sidekiq execution SLIs (service level indicators) | null |
{{< history >}}
- [Introduced](https://gitlab.com/groups/gitlab-com/gl-infra/-/epics/700) in GitLab 16.0. This version of Sidekiq execution SLIs replaces the old version of the SLI where you can now drill down by workers in the [Application SLI Violations dashboard](https://dashboards.gitlab.net/d/general-applicatio... | ---
stage: Platforms
group: Scalability
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Sidekiq execution SLIs (service level indicators)
breadcrumbs:
- doc
- developme... |
https://docs.gitlab.com/development/labels | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/labels | [
"doc",
"development",
"labels"
] | _index.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Labels | null |
To allow for asynchronous issue handling, we use [milestones](https://gitlab.com/groups/gitlab-org/-/milestones)
and [labels](https://gitlab.com/gitlab-org/gitlab/-/labels). Leads and product managers handle most of the
scheduling into milestones. Labeling is a task for everyone. (For some projects, labels can be set... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Labels
breadcrumbs:
- doc
- development
- labels
---
To allow for asynchronous issue... |
https://docs.gitlab.com/development/compatibility_across_updates | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/compatibility_across_updates.md | 2025-08-13 | doc/development/sidekiq | [
"doc",
"development",
"sidekiq"
] | compatibility_across_updates.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Sidekiq Compatibility across Updates | null |
The arguments for a Sidekiq job are stored in a queue while it is
scheduled for execution. During a online update, this could lead to
several possible situations:
1. An older version of the application publishes a job, which is executed by an
upgraded Sidekiq node.
1. A job is queued before an upgrade, but execut... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Sidekiq Compatibility across Updates
breadcrumbs:
- doc
- development
- sidekiq
---
... |
https://docs.gitlab.com/development/limited_capacity_worker | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/limited_capacity_worker.md | 2025-08-13 | doc/development/sidekiq | [
"doc",
"development",
"sidekiq"
] | limited_capacity_worker.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Sidekiq limited capacity worker | null |
{{< alert type="note" >}}
The following documentation for limited capacity worker relates to a specific
type of worker that usually does not take arguments but instead gets work from
a custom queue (for example, a PostgreSQL backlog of work). It cannot be used for
throttling normal Sidekiq workers. To restrict the c... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Sidekiq limited capacity worker
breadcrumbs:
- doc
- development
- sidekiq
---
{{< a... |
https://docs.gitlab.com/development/worker_attributes | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/worker_attributes.md | 2025-08-13 | doc/development/sidekiq | [
"doc",
"development",
"sidekiq"
] | worker_attributes.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Sidekiq worker attributes | null |
Worker classes can define certain attributes to control their behavior and add metadata.
Child classes inheriting from other workers also inherit these attributes, so you only
have to redefine them if you want to override their values.
## Job urgency
Jobs can have an `urgency` attribute set, which can be `:high`,
... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Sidekiq worker attributes
breadcrumbs:
- doc
- development
- sidekiq
---
Worker clas... |
https://docs.gitlab.com/development/idempotent_jobs | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/idempotent_jobs.md | 2025-08-13 | doc/development/sidekiq | [
"doc",
"development",
"sidekiq"
] | idempotent_jobs.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Sidekiq idempotent jobs | null |
It's known that a job can fail for multiple reasons. For example, network outages or bugs.
In order to address this, Sidekiq has a built-in retry mechanism that is
used by default by most workers within GitLab.
It's expected that a job can run again after a failure without major side-effects for the
application or u... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Sidekiq idempotent jobs
breadcrumbs:
- doc
- development
- sidekiq
---
It's known th... |
https://docs.gitlab.com/development/logging | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/logging.md | 2025-08-13 | doc/development/sidekiq | [
"doc",
"development",
"sidekiq"
] | logging.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Sidekiq logging | null |
## Worker context
To have some more information about workers in the logs, we add
[metadata to the jobs in the form of an `ApplicationContext`](../logging.md#logging-context-metadata-through-rails-or-grape-requests).
In most cases, when scheduling a job from a request, this context is already
deduced from the reques... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Sidekiq logging
breadcrumbs:
- doc
- development
- sidekiq
---
## Worker context
To... |
https://docs.gitlab.com/development/sidekiq | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/sidekiq | [
"doc",
"development",
"sidekiq"
] | _index.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Sidekiq development guidelines | null |
We use [Sidekiq](https://github.com/mperham/sidekiq) as our background
job processor. These guides are for writing jobs that work well on
GitLab.com and are consistent with our existing worker classes. For
information on administering GitLab, see [configuring Sidekiq](../../administration/sidekiq/_index.md).
There a... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Sidekiq development guidelines
breadcrumbs:
- doc
- development
- sidekiq
---
We use... |
https://docs.gitlab.com/development/principles_of_importer_design | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/principles_of_importer_design.md | 2025-08-13 | doc/development/import | [
"doc",
"development",
"import"
] | principles_of_importer_design.md | Create | Import | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Principles of Importer Design | null |
## Security
- Uploaded files must be validated. Examples:
- [`BulkImports::FileDownloadService`](https://gitlab.com/gitlab-org/gitlab/-/blob/cd4a880cbb2bc56b3a55f14c1d8370f4385319db/app/services/bulk_imports/file_download_service.rb#L38-46)
- [`ImportExport::CommandLineUtil`](https://gitlab.com/gitlab-org/gitlab... | ---
stage: Create
group: Import
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Principles of Importer Design
breadcrumbs:
- doc
- development
- import
---
## Securit... |
https://docs.gitlab.com/development/components | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/components.md | 2025-08-13 | doc/development/cicd | [
"doc",
"development",
"cicd"
] | components.md | Verify | Pipeline Authoring | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Development guide for GitLab official CI/CD components | null |
This document explains how to develop [CI/CD components](../../ci/components/_index.md) that are maintained by GitLab, either the official public ones or those for internal use.
The location for all official GitLab component projects is the [`gitlab.com/components`](https://gitlab.com/components) group.
This group c... | ---
stage: Verify
group: Pipeline Authoring
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Development guide for GitLab official CI/CD components
breadcrumbs:
- doc
- ... |
https://docs.gitlab.com/development/configuration | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/configuration.md | 2025-08-13 | doc/development/cicd | [
"doc",
"development",
"cicd"
] | configuration.md | Verify | Pipeline Authoring | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Contribute to the CI/CD configuration | null |
## Glossary
- **CI/CD configuration**: The YAML file that defines the CI/CD configuration for a project.
- **keyword**: Each keyword in the CI/CD configuration.
- **entry**: An `Entry` class that represents a keyword in the CI/CD configuration.
Not every keyword in the CI/CD configuration is represented by an `Entr... | ---
stage: Verify
group: Pipeline Authoring
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Contribute to the CI/CD configuration
breadcrumbs:
- doc
- development
- cic... |
https://docs.gitlab.com/development/cicd | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/cicd | [
"doc",
"development",
"cicd"
] | _index.md | Verify | Pipeline Execution | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | CI/CD development guidelines | null |
CI/CD pipelines are a fundamental part of GitLab development and deployment processes, automating tasks like building,
testing, and deploying code changes.
When developing features that interact with or trigger pipelines, it's essential to consider the broader implications
these actions have on the system's security ... | ---
stage: Verify
group: Pipeline Execution
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: CI/CD development guidelines
breadcrumbs:
- doc
- development
- cicd
---
C... |
https://docs.gitlab.com/development/templates | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/templates.md | 2025-08-13 | doc/development/cicd | [
"doc",
"development",
"cicd"
] | templates.md | Verify | Pipeline Authoring | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Development guide for GitLab CI/CD templates (Deprecated) | null |
{{< alert type="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 ... | ---
stage: Verify
group: Pipeline Authoring
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Development guide for GitLab CI/CD templates (Deprecated)
breadcrumbs:
- doc... |
https://docs.gitlab.com/development/testing | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/testing.md | 2025-08-13 | doc/development/cicd | [
"doc",
"development",
"cicd"
] | testing.md | Verify | Pipeline Authoring | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Testing guide for CI/CD Rails application code | null |
This document contains details for testing CI/CD application code.
## Backend
### Integration specs
The CI/CD specs include informal integration specs for the core CI/CD processes.
#### Linting
Integration specs for linting are kept in `spec/lib/gitlab/ci/yaml_processor_spec.rb` and
`spec/lib/gitlab/ci/yaml_proc... | ---
stage: Verify
group: Pipeline Authoring
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Testing guide for CI/CD Rails application code
breadcrumbs:
- doc
- developm... |
https://docs.gitlab.com/development/pipeline_wizard | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/pipeline_wizard.md | 2025-08-13 | doc/development/cicd | [
"doc",
"development",
"cicd"
] | pipeline_wizard.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Pipeline Wizard | null |
The Pipeline Wizard is a Vue frontend component that helps users create a
pipeline by using input fields. The type of input fields and the form of the final
pipeline is configured by a YAML template.
The Pipeline Wizard expects a single template file that configures the user
flow. The wizard is agnostic with regards... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Pipeline Wizard
breadcrumbs:
- doc
- development
- cicd
---
The Pipeline Wizard is a... |
https://docs.gitlab.com/development/cicd_reference_documentation_guide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/cicd_reference_documentation_guide.md | 2025-08-13 | doc/development/cicd | [
"doc",
"development",
"cicd"
] | cicd_reference_documentation_guide.md | Verify | Pipeline Authoring | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Documenting pipeline configuration keywords | null |
The [CI/CD YAML syntax reference](../../ci/yaml/_index.md) uses a standard style to make it easier to use and update.
The reference information should be kept as simple as possible, and expanded details
and examples should be documented on other pages.
## YAML reference structure
Every YAML keyword must have its o... | ---
stage: Verify
group: Pipeline Authoring
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Documenting pipeline configuration keywords
breadcrumbs:
- doc
- development... |
https://docs.gitlab.com/development/schema | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/schema.md | 2025-08-13 | doc/development/cicd | [
"doc",
"development",
"cicd"
] | schema.md | Verify | Pipeline Authoring | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Contribute to the CI/CD Schema | null |
The [pipeline editor](../../ci/pipeline_editor/_index.md) uses a CI/CD schema to enhance
the authoring experience of our CI/CD configuration files. With the CI/CD schema, the editor can:
- Validate the content of the CI/CD configuration file as it is being written in the editor.
- Provide autocomplete functionality ... | ---
stage: Verify
group: Pipeline Authoring
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Contribute to the CI/CD Schema
breadcrumbs:
- doc
- development
- cicd
---
... |
https://docs.gitlab.com/development/cicd_tables | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/cicd_tables.md | 2025-08-13 | doc/development/cicd | [
"doc",
"development",
"cicd"
] | cicd_tables.md | Verify | Pipeline Execution | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Add new tables to the CI database | null |
The [pipeline data partitioning](https://handbook.gitlab.com/handbook/engineering/architecture/design-documents/ci_data_decay/pipeline_partitioning/)
design document describes how to partition existing tables in the CI domain. However,
you still need to add tables for new features. Sometimes these tables hold
referen... | ---
stage: Verify
group: Pipeline Execution
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Add new tables to the CI database
breadcrumbs:
- doc
- development
- cicd
--... |
https://docs.gitlab.com/development/cloud_connector | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/cloud_connector | [
"doc",
"development",
"cloud_connector"
] | _index.md | Shared ownership | Shared ownership | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Cloud Connector | null |
GitLab Cloud Connector is a way to access services common to
multiple GitLab deployments, instances, and cells. As of now, Cloud Connector is not a
dedicated service itself, but rather a collection of APIs and code that standardizes the approach to authentication and
other items when integrating Cloud based services ... | ---
stage: Shared ownership
group: Shared ownership
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Cloud Connector
breadcrumbs:
- doc
- development
- cloud_connector
-... |
https://docs.gitlab.com/development/configuration | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/configuration.md | 2025-08-13 | doc/development/cloud_connector | [
"doc",
"development",
"cloud_connector"
] | configuration.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Cloud Connector: Configuration | null |
A GitLab Rails instance accesses backend services uses a [Cloud Connector Service Access Token](architecture.md#access-control):
- This token is synced to a GitLab instance from CustomersDot daily and stored in the instance's local database.
- For GitLab.com, we do not require this step; instead, we issue short-live... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: 'Cloud Connector: Configuration'
breadcrumbs:
- doc
- development
- cloud_connector
--... |
https://docs.gitlab.com/development/architecture | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/architecture.md | 2025-08-13 | doc/development/cloud_connector | [
"doc",
"development",
"cloud_connector"
] | architecture.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Cloud Connector: Architecture | null |
[GitLab Cloud Connector](https://about.gitlab.com/direction/cloud-connector/) is a way to access services common to
multiple GitLab deployments, instances, and cells. As of now, Cloud Connector is not a
dedicated service itself, but rather a collection of APIs and code that standardizes the approach to authentication... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: 'Cloud Connector: Architecture'
breadcrumbs:
- doc
- development
- cloud_connector
---... |
https://docs.gitlab.com/development/ruby_style_guide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/ruby_style_guide.md | 2025-08-13 | doc/development/backend | [
"doc",
"development",
"backend"
] | ruby_style_guide.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Ruby style guide | null |
This is a GitLab-specific style guide for Ruby code. Everything documented in this page can be [reopened for discussion](https://handbook.gitlab.com/handbook/values/#disagree-commit-and-disagree).
We use [RuboCop](../rubocop_development_guide.md) to enforce Ruby style guide rules.
Where a RuboCop rule is absent, re... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Ruby style guide
breadcrumbs:
- doc
- development
- backend
---
This is a GitLab-spe... |
https://docs.gitlab.com/development/backend/gitaly_touch_points | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/backend/gitaly_touch_points.md | 2025-08-13 | doc/development/backend/create_source_code_be | [
"doc",
"development",
"backend",
"create_source_code_be"
] | gitaly_touch_points.md | Create | Source Code | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Source Code - Gitaly Touch Points | null |
## RPCs
Gitaly is a wrapper around the `git` binary. It provides managed access to the file system housing the `git` repositories, using Go Remote Procedure Calls (RPCs). Other functions are access optimization, caching, and a form of pagination against the file system.
The [Beginner's guide to Gitaly contributions... | ---
stage: Create
group: Source Code
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Source Code - Gitaly Touch Points
breadcrumbs:
- doc
- development
- backend
- crea... |
https://docs.gitlab.com/development/backend/create_source_code_be | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/backend/_index.md | 2025-08-13 | doc/development/backend/create_source_code_be | [
"doc",
"development",
"backend",
"create_source_code_be"
] | _index.md | Create | Source Code | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Source Code Management | null |
The Source Code Management team is responsible for all backend aspects of the product categories
that fall under the [Source Code group](https://handbook.gitlab.com/handbook/product/categories/#source-code-group)
of the [Create stage](https://handbook.gitlab.com/handbook/product/categories/#create-stage)
of the [DevO... | ---
stage: Create
group: Source Code
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Source Code Management
breadcrumbs:
- doc
- development
- backend
- create_source_c... |
https://docs.gitlab.com/development/organization | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/organization | [
"doc",
"development",
"organization"
] | _index.md | Tenant Scale | Organizations | See the Technical Writers assigned to Development Guidelines: https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-development-guidelines | Organization | Development Guidelines: learn about organization when developing GitLab. |
The [Organization initiative](../../user/organization/_index.md) focuses on reaching feature parity between
GitLab.com and GitLab Self-Managed.
## Consolidate groups and projects
- [Architecture design document](https://handbook.gitlab.com/handbook/engineering/architecture/design-documents/consolidating_groups_and_... | ---
stage: Tenant Scale
group: Organizations
info: 'See the Technical Writers assigned to Development Guidelines: https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments-to-development-guidelines'
description: 'Development Guidelines: learn about organization when developing GitLab.'
title: Organ... |
https://docs.gitlab.com/development/organization/sharding | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/organization/_index.md | 2025-08-13 | doc/development/organization/sharding | [
"doc",
"development",
"organization",
"sharding"
] | _index.md | Tenant Scale | Organizations | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Sharding guidelines | Guidance and principles for sharding database tables to support organization isolation |
The sharding initiative is a long-running project to ensure that most GitLab database tables can be related to an `Organization`, either directly or indirectly. This involves adding an `organization_id`, `namespace_id` or `project_id` column to tables, and backfilling their `NOT NULL` fallback data. This work is impo... | ---
stage: Tenant Scale
group: Organizations
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
description: Guidance and principles for sharding database tables to support organ... |
https://docs.gitlab.com/development/rails_endpoints | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/rails_endpoints | [
"doc",
"development",
"rails_endpoints"
] | _index.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Rails Endpoints | null |
Rails Endpoints are used by different GitLab components, they cannot be
used by other consumers. This documentation is intended for people
working on the GitLab codebase.
These Rails Endpoints:
- May not have extensive documentation or follow the same conventions as our public or private APIs.
- May not adhere to s... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Rails Endpoints
breadcrumbs:
- doc
- development
- rails_endpoints
---
Rails Endpoints are use... |
https://docs.gitlab.com/development/backup_gitlab | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/backup_gitlab.md | 2025-08-13 | doc/development/backup_and_restore | [
"doc",
"development",
"backup_and_restore"
] | backup_gitlab.md | Tenant Scale | Geo | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | How GitLab backups work? | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab Self-Managed
{{< /details >}}
GitLab provides recommendations for how to create application backups across different installation types and different hosting architectures. We provide simple tools to create a point-in-time application backup, as we... | ---
stage: Tenant Scale
group: Geo
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: How GitLab backups work?
breadcrumbs:
- doc
- development
- backup_and_restore
---
{{< details >... |
https://docs.gitlab.com/development/translation | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/translation.md | 2025-08-13 | doc/development/i18n | [
"doc",
"development",
"i18n"
] | translation.md | none | Localization | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Translating GitLab | null |
For managing the translation process, we use [Crowdin](https://crowdin.com).
To contribute translations at [`translate.gitlab.com`](https://translate.gitlab.com),
you must create a Crowdin account. You may create a new account or use any of their supported
sign-in services.
## Language selections
GitLab is being tr... | ---
stage: none
group: Localization
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Translating GitLab
breadcrumbs:
- doc
- development
- i18n
---
For managing the tr... |
https://docs.gitlab.com/development/proofreader | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/proofreader.md | 2025-08-13 | doc/development/i18n | [
"doc",
"development",
"i18n"
] | proofreader.md | Create | Import | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Proofread Translations | null |
Most translations are contributed, reviewed, and accepted by the community. We
are very appreciative of the work done by translators and proofreaders!
## Proofreaders
<!-- vale gitlab_base.Spelling = NO -->
- Albanian
- Proofreaders needed.
- Amharic
- Proofreaders needed.
- Arabic
- Proofreaders needed.
- B... | ---
stage: Create
group: Import
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Proofread Translations
breadcrumbs:
- doc
- development
- i18n
---
Most translations a... |
https://docs.gitlab.com/development/merging_translations | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/merging_translations.md | 2025-08-13 | doc/development/i18n | [
"doc",
"development",
"i18n"
] | merging_translations.md | Create | Import | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Merging translations from Crowdin | null |
Crowdin automatically syncs the `gitlab.pot` file with the Crowdin service, presenting
newly added externalized strings to the community of translators.
The [GitLab Crowdin Bot](https://gitlab.com/gitlab-crowdin-bot) also creates merge requests
to take newly approved translation submissions and merge them into the `... | ---
stage: Create
group: Import
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Merging translations from Crowdin
breadcrumbs:
- doc
- development
- i18n
---
Crowdin ... |
https://docs.gitlab.com/development/externalization | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/externalization.md | 2025-08-13 | doc/development/i18n | [
"doc",
"development",
"i18n"
] | externalization.md | Create | Import | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Internationalization for GitLab | null |
For working with internationalization (i18n),
[GNU gettext](https://www.gnu.org/software/gettext/) is used given it's the most
used tool for this task and there are many applications that help us work with it.
{{< alert type="note" >}}
All `rake` commands described on this page must be run on a GitLab instance. Thi... | ---
stage: Create
group: Import
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Internationalization for GitLab
breadcrumbs:
- doc
- development
- i18n
---
For workin... |
https://docs.gitlab.com/development/i18n | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/i18n | [
"doc",
"development",
"i18n"
] | _index.md | Create | Import | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Translate GitLab to your language | null |
The text in the GitLab user interface is in American English by default. Each string can be
translated to other languages. As each string is translated, it's added to the languages translation
file and made available in future GitLab releases.
Contributions to translations are always needed. Many strings are not yet... | ---
stage: Create
group: Import
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Translate GitLab to your language
breadcrumbs:
- doc
- development
- i18n
---
The text... |
https://docs.gitlab.com/development/banzai_pipeline_and_parsing | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/banzai_pipeline_and_parsing.md | 2025-08-13 | doc/development/gitlab_flavored_markdown | [
"doc",
"development",
"gitlab_flavored_markdown"
] | banzai_pipeline_and_parsing.md | Plan | Knowledge | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | The Banzai pipeline and parsing | The Banzai pipeline and parsing. |
<!-- vale gitlab.GitLabFlavoredMarkdown = NO -->
Parsing and rendering [GitLab Flavored Markdown](_index.md) into HTML involves different components:
- Banzai pipeline and it's various filters
- Markdown parser
The backend does all the processing for GLFM to HTML. This provides several benefits:
- Security: We ru... | ---
stage: Plan
group: Knowledge
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
description: The Banzai pipeline and parsing.
title: The Banzai pipeline and parsing
breadcrum... |
https://docs.gitlab.com/development/gitlab_flavored_markdown | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/gitlab_flavored_markdown | [
"doc",
"development",
"gitlab_flavored_markdown"
] | _index.md | Plan | Knowledge | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | GitLab Flavored Markdown (GLFM) development guidelines | Development guidelines for GitLab Flavored Markdown (GLFM). |
<!-- vale gitlab_base.GitLabFlavoredMarkdown = NO -->
This and neighboring pages contain developer guidelines for GitLab Flavored Markdown (GLFM).
For the user documentation about Markdown in GitLab, refer to
[GitLab Flavored Markdown](../../user/markdown.md).
GitLab supports Markdown in various places, such as iss... | ---
stage: Plan
group: Knowledge
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
description: Development guidelines for GitLab Flavored Markdown (GLFM).
title: GitLab Flavore... |
https://docs.gitlab.com/development/reference_processing | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/reference_processing.md | 2025-08-13 | doc/development/gitlab_flavored_markdown | [
"doc",
"development",
"gitlab_flavored_markdown"
] | reference_processing.md | Plan | Knowledge | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Reference processing | An introduction to reference parsers and reference filters, and a guide to their implementation. |
[GitLab Flavored Markdown](../../user/markdown.md) includes the ability to process
references to a range of GitLab domain objects. This is implemented by two
abstractions in the `Banzai` pipeline: `ReferenceFilter` and `ReferenceParser`.
This page explains what these are, how they are used, and how you would
implemen... | ---
stage: Plan
group: Knowledge
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
description: An introduction to reference parsers and reference filters, and a guide
to thei... |
https://docs.gitlab.com/development/product_qualified_lead_guide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/product_qualified_lead_guide | [
"doc",
"development",
"product_qualified_lead_guide"
] | _index.md | Growth | Acquisition | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Product Qualified Lead (PQL) development guidelines | null |
The Product Qualified Lead (PQL) funnel connects our users with our team members. Read more about [PQL product principles](https://handbook.gitlab.com/handbook/product/product-principles/#product-qualified-leads-pqls).
A hand-raise PQL is a user who requests to speak to sales from within the product.
## Set up your... | ---
stage: Growth
group: Acquisition
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Product Qualified Lead (PQL) development guidelines
breadcrumbs:
- doc
- developmen... |
https://docs.gitlab.com/development/shell_scripting_guide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/shell_scripting_guide | [
"doc",
"development",
"shell_scripting_guide"
] | _index.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Shell scripting standards and style guidelines | null |
GitLab consists of many various services and sub-projects. The majority of
their backend code is written in [Ruby](https://www.ruby-lang.org) and
[Go](https://go.dev/). However, some of them use shell scripts for
automation of routine system administration tasks like deployment,
installation, etc. It's being done eit... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Shell scripting standards and style guidelines
breadcrumbs:
- doc
- development
- shel... |
https://docs.gitlab.com/development/style_guides | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/style_guides.md | 2025-08-13 | doc/development/contributing | [
"doc",
"development",
"contributing"
] | style_guides.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Development style guides | null |
## Editor/IDE styling standardization
We use [EditorConfig](https://editorconfig.org/) to automatically apply certain styling standards before files are saved
locally. Some editors and IDEs honor the `.editorconfig` settings [automatically by default](https://editorconfig.org/#pre-installed).
If your editor or IDE ... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Development style guides
breadcrumbs:
- doc
- development
- contributing
---
## Edit... |
https://docs.gitlab.com/development/merge_request_workflow | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/merge_request_workflow.md | 2025-08-13 | doc/development/contributing | [
"doc",
"development",
"contributing"
] | merge_request_workflow.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Merge requests workflow | null |
We welcome merge requests from everyone, with fixes and improvements
to GitLab code, tests, and documentation. The issues that are specifically suitable
for community contributions have the
[`Seeking community contributions`](../labels/_index.md#label-for-community-contributors)
label, but you are free to contribute ... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Merge requests workflow
breadcrumbs:
- doc
- development
- contributing
---
We welco... |
https://docs.gitlab.com/development/contributing | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/contributing | [
"doc",
"development",
"contributing"
] | _index.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Contribute to GitLab development | Code contribution guidelines, style guides, and processes. |
Thank you for your interest in contributing to GitLab.
You can contribute new features, changes to code or processes, typo fixes,
or updates to language in the interface.
This guide details how to contribute to the development of GitLab.
For a step-by-step guide for first-time contributors, see [Tutorial: Make a Gi... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
description: Code contribution guidelines, style guides, and processes.
title: Contribute to ... |
https://docs.gitlab.com/development/design | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/design.md | 2025-08-13 | doc/development/contributing | [
"doc",
"development",
"contributing"
] | design.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Design and user interface changes | null |
Follow these guidelines when contributing or reviewing design and user interface
(UI) changes. Refer to our [code review guide](../code_review.md) for broader
advice and best practices for code review in general.
The basis for most of these guidelines is [Pajamas](https://design.gitlab.com/),
GitLab design system. W... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Design and user interface changes
breadcrumbs:
- doc
- development
- contributing
---
... |
https://docs.gitlab.com/development/issue_workflow | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/issue_workflow.md | 2025-08-13 | doc/development/contributing | [
"doc",
"development",
"contributing"
] | issue_workflow.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Issues workflow | null |
## Creating an issue
**Before you submit an issue, [search the issue tracker](https://gitlab.com/gitlab-org/gitlab/-/issues)**
for similar entries. Someone else might have already had the same bug or feature proposal.
If you find an existing issue, show your support with an emoji reaction and add your notes to the d... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Issues workflow
breadcrumbs:
- doc
- development
- contributing
---
## Creating an i... |
https://docs.gitlab.com/development/merge_request_coaches | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/merge_request_coaches.md | 2025-08-13 | doc/development/contributing | [
"doc",
"development",
"contributing"
] | merge_request_coaches.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | How GitLab Merge Request Coaches can help you | null |
Welcome, GitLab contributor! As you work on your contributions, Merge Request (MR) Coaches are here to help you succeed. This guide explains how we can support you throughout your contribution journey.
## What is a Merge Request Coach?
MR Coaches are GitLab team members with a special interest in helping community ... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: How GitLab Merge Request Coaches can help you
breadcrumbs:
- doc
- development
- contr... |
https://docs.gitlab.com/development/contributing/contribute-gitpod | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/contributing/contribute-gitpod.md | 2025-08-13 | doc/development/contributing/first_contribution | [
"doc",
"development",
"contributing",
"first_contribution"
] | contribute-gitpod.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Contribute code with Gitpod | null |
Now for the fun part. Let's edit some code.
In this example, I found some UI text I'd like to change.
In the upper-right corner in GitLab, I selected my avatar and then **Preferences**.
I want to change `Syntax highlighting theme` to `Code syntax highlighting theme`:
{{< alert type="warning" >}}
This tutorial is d... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Contribute code with Gitpod
breadcrumbs:
- doc
- development
- contributing
- first_co... |
https://docs.gitlab.com/development/contributing/configure-dev-env-gitpod | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/contributing/configure-dev-env-gitpod.md | 2025-08-13 | doc/development/contributing/first_contribution | [
"doc",
"development",
"contributing",
"first_contribution"
] | configure-dev-env-gitpod.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Configure the Gitpod development environment | null |
To contribute code without the overhead of setting up a local development environment,
you should use Gitpod.
## Use Gitpod to contribute without a local environment setup
Set aside about 15 minutes to launch the GDK in Gitpod.
1. [Launch the GDK in Gitpod](https://gitpod.io/#https://gitlab.com/gitlab-community/gi... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Configure the Gitpod development environment
breadcrumbs:
- doc
- development
- contri... |
https://docs.gitlab.com/development/contributing/contribute-gdk | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/contributing/contribute-gdk.md | 2025-08-13 | doc/development/contributing/first_contribution | [
"doc",
"development",
"contributing",
"first_contribution"
] | contribute-gdk.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Contribute code with GDK | null |
Now for the fun part. Let's edit some code.
In this example, I found some UI text I'd like to change.
In the upper-right corner in GitLab, I selected my avatar and then **Preferences**.
I want to change `Syntax highlighting theme` to `Code syntax highlighting theme`:
{{< alert type="warning" >}}
This tutorial is d... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Contribute code with GDK
breadcrumbs:
- doc
- development
- contributing
- first_contr... |
https://docs.gitlab.com/development/contributing/mr-review | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/contributing/mr-review.md | 2025-08-13 | doc/development/contributing/first_contribution | [
"doc",
"development",
"contributing",
"first_contribution"
] | mr-review.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Create a merge request | null |
Now you're ready to push changes from the community fork to the main GitLab repository!
[View an interactive demo of this step](https://gitlab.navattic.com/tu5n0haw).
1. Go to [the community fork on GitLab.com](https://gitlab.com/gitlab-community/gitlab).
You should see a message like this one:
![A banner pr... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Create a merge request
breadcrumbs:
- doc
- development
- contributing
- first_contrib... |
https://docs.gitlab.com/development/contributing/contribute-web-ide | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/contributing/contribute-web-ide.md | 2025-08-13 | doc/development/contributing/first_contribution | [
"doc",
"development",
"contributing",
"first_contribution"
] | contribute-web-ide.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Contribute code with the Web IDE | null |
The [GitLab Web IDE](../../../user/project/web_ide/_index.md) is a built-in advanced editor with commit staging.
{{< alert type="warning" >}}
This tutorial is designed to be a general introduction to contributing to the GitLab project
and is not an example of a change that should be submitted for review.
{{< /aler... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Contribute code with the Web IDE
breadcrumbs:
- doc
- development
- contributing
- fir... |
https://docs.gitlab.com/development/contributing/configure-dev-env-gdk | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/contributing/configure-dev-env-gdk.md | 2025-08-13 | doc/development/contributing/first_contribution | [
"doc",
"development",
"contributing",
"first_contribution"
] | configure-dev-env-gdk.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Install the GDK development environment | null |
If you want to contribute to the GitLab codebase and want a development environment in which to test
your changes, you can use [the GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit),
a local version of GitLab that's yours to play with.
The GDK is a local development environment that... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Install the GDK development environment
breadcrumbs:
- doc
- development
- contributin... |
https://docs.gitlab.com/development/contributing/configure-dev-env-gdk-in-a-box | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/contributing/configure-dev-env-gdk-in-a-box.md | 2025-08-13 | doc/development/contributing/first_contribution | [
"doc",
"development",
"contributing",
"first_contribution"
] | configure-dev-env-gdk-in-a-box.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Configure GDK-in-a-box | null |
If you want to contribute to the GitLab codebase and want a development environment in which to test
your changes, you can use
[GDK-in-a-box](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/gdk_in_a_box.md). GDK-in-a-box is available as a multi-platform container image, pre-configured with [the G... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Configure GDK-in-a-box
breadcrumbs:
- doc
- development
- contributing
- first_contrib... |
https://docs.gitlab.com/development/contributing/first_contribution | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/contributing/_index.md | 2025-08-13 | doc/development/contributing/first_contribution | [
"doc",
"development",
"contributing",
"first_contribution"
] | _index.md | none | unassigned | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Tutorial: Make a GitLab contribution | null |
Everyone can contribute to the development of GitLab.
You can contribute new features, changes to code or processes, typo fixes,
or updates to language in the interface.
This tutorial walks you through the contribution process with an example of updating UI text and related files.
You can follow this tutorial to fam... | ---
stage: none
group: unassigned
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: 'Tutorial: Make a GitLab contribution'
breadcrumbs:
- doc
- development
- contributing... |
https://docs.gitlab.com/development/contributing/verify | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/contributing/_index.md | 2025-08-13 | doc/development/contributing/verify | [
"doc",
"development",
"contributing",
"verify"
] | _index.md | Verify | Pipeline Execution | null | Contribute to Verify stage codebase | null |
## What are we working on in Verify?
Verify stage is working on a comprehensive Continuous Integration platform
integrated into the GitLab product. Our goal is to empower our users to make
great technical and business decisions, by delivering a fast, reliable, secure
platform that verifies assumptions that our users... | ---
stage: Verify
group: Pipeline Execution
title: Contribute to Verify stage codebase
breadcrumbs:
- doc
- development
- contributing
- verify
---
## What are we working on in Verify?
Verify stage is working on a comprehensive Continuous Integration platform
integrated into the GitLab product. Our goal is to empowe... |
https://docs.gitlab.com/development/repository_storage_moves | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/development/_index.md | 2025-08-13 | doc/development/repository_storage_moves | [
"doc",
"development",
"repository_storage_moves"
] | _index.md | Create | Source Code | Any user with at least the Maintainer role can merge updates to this content. For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review. | Project Repository Storage Moves | null |
This document was created to help contributors understand the code design of
[project repository storage moves](../../api/project_repository_storage_moves.md).
Read this document before making changes to the code for this feature.
This document is intentionally limited to an overview of how the code is
designed, as ... | ---
stage: Create
group: Source Code
info: Any user with at least the Maintainer role can merge updates to this content.
For details, see https://docs.gitlab.com/development/development_processes/#development-guidelines-review.
title: Project Repository Storage Moves
breadcrumbs:
- doc
- development
- repository_stor... |
https://docs.gitlab.com/set_up_organization | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/set_up_organization.md | 2025-08-13 | doc/topics | [
"doc",
"topics"
] | set_up_organization.md | none | unassigned | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Manage your organization | Users, groups, namespaces, SSH keys. |
Configure your organization and its users. Determine user roles
and give everyone access to the projects they need.
{{< cards >}}
- [Tutorial: Set up your organization](../tutorials/manage_user/_index.md)
- [Namespaces](../user/namespace/_index.md)
- [Members](../user/project/members/_index.md)
- [Organization (in ... | ---
stage: none
group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Users, groups, namespaces, SSH keys.
title: Manage your organization
breadcrumbs:
- doc
- top... |
https://docs.gitlab.com/build_your_application | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/build_your_application.md | 2025-08-13 | doc/topics | [
"doc",
"topics"
] | build_your_application.md | none | unassigned | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Use CI/CD to build your application | Runners, jobs, pipelines, variables. |
Use CI/CD to generate your application.
{{< cards >}}
- [Getting started](../ci/_index.md)
- [CI/CD YAML syntax reference](../ci/yaml/_index.md)
- [Runners](../ci/runners/_index.md)
- [Pipelines](../ci/pipelines/_index.md)
- [Jobs](../ci/jobs/_index.md)
- [CI/CD components](../ci/components/_index.md)
- [CI/CD vari... | ---
stage: none
group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Runners, jobs, pipelines, variables.
title: Use CI/CD to build your application
breadcrumbs:
... |
https://docs.gitlab.com/gitlab_flow | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/gitlab_flow.md | 2025-08-13 | doc/topics | [
"doc",
"topics"
] | gitlab_flow.md | null | null | null | null | null |
<!-- markdownlint-disable -->
<!-- vale off -->
This document was moved to [another location](https://about.gitlab.com/blog/2023/07/27/gitlab-flow-duo/).
<!-- This redirect file can be deleted after <2025-10-08>. -->
<!-- Redirects that point to other docs in the same project expire in three months. -->
<!-- Redire... | ---
redirect_to: https://about.gitlab.com/blog/2023/07/27/gitlab-flow-duo/
remove_date: '2025-10-08'
breadcrumbs:
- doc
- topics
---
<!-- markdownlint-disable -->
<!-- vale off -->
This document was moved to [another location](https://about.gitlab.com/blog/2023/07/27/gitlab-flow-duo/).
<!-- This redirect file can b... |
https://docs.gitlab.com/release_your_application | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/release_your_application.md | 2025-08-13 | doc/topics | [
"doc",
"topics"
] | release_your_application.md | none | unassigned | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Deploy and release your application | Environments, packages, review apps, GitLab Pages. |
Deployment is the step of the software delivery process when your
application gets deployed to its final, target infrastructure.
You can deploy your application internally or to the public.
Preview a release in a review app, and use feature flags to
release features incrementally.
{{< cards >}}
- [Getting started]... | ---
stage: none
group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Environments, packages, review apps, GitLab Pages.
title: Deploy and release your application... |
https://docs.gitlab.com/manage_code | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/manage_code.md | 2025-08-13 | doc/topics | [
"doc",
"topics"
] | manage_code.md | none | unassigned | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Manage your code | Repositories, merge requests, remote development. |
Store your source files in a repository and create merge requests. Write, debug, and collaborate on code.
{{< cards >}}
- [Getting started](../user/get_started/get_started_managing_code.md)
- [Repositories](../user/project/repository/_index.md)
- [Merge requests](../user/project/merge_requests/_index.md)
- [Remote ... | ---
stage: none
group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Repositories, merge requests, remote development.
title: Manage your code
breadcrumbs:
- doc
... |
https://docs.gitlab.com/plan_and_track | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/plan_and_track.md | 2025-08-13 | doc/topics | [
"doc",
"topics"
] | plan_and_track.md | Plan | Project Management | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Plan and track work | Epics, issues, milestones, and labels. |
Plan your work by creating requirements, issues, and epics. Schedule work
with milestones and track your team's time. Learn how to save time with
quick actions, see how GitLab renders Markdown text, and learn how to
use Git to interact with GitLab.
<!-- vale gitlab_base.Spelling = NO -->
<i class="fa fa-youtube-pla... | ---
stage: Plan
group: Project Management
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Epics, issues, milestones, and labels.
title: Plan and track work
breadcrumbs:
- doc
... |
https://docs.gitlab.com/topics/runner_fleet_design_guides | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/_index.md | 2025-08-13 | doc/topics/runner_fleet_design_guides | [
"doc",
"topics",
"runner_fleet_design_guides"
] | _index.md | CI | Runner | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | GitLab Runner fleet configuration and best practices | Runner Fleet. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed
{{< /details >}}
Set up and manage your GitLab Runner infrastructure with proven strategies and recommendations.
Use these recommendations to develop a GitLab Runner deployment strategy based on your organization's require... | ---
stage: CI
group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Runner Fleet.
title: GitLab Runner fleet configuration and best practices
breadcrumbs:
- doc
- topi... |
https://docs.gitlab.com/topics/gitlab_runner_fleet_config_and_best_practices | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/gitlab_runner_fleet_config_and_best_practices.md | 2025-08-13 | doc/topics/runner_fleet_design_guides | [
"doc",
"topics",
"runner_fleet_design_guides"
] | gitlab_runner_fleet_config_and_best_practices.md | CI | Runner | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Design and configure a GitLab Runner fleet on Google Kubernetes Engine | Runner Fleet. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed
{{< /details >}}
Use these recommendations to analyze your CI/CD build requirements to design, configure,
and validate a GitLab Runner fleet hosted on Google Kubernetes Engine (GKE).
The following diagram illustrates the p... | ---
stage: CI
group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Runner Fleet.
title: Design and configure a GitLab Runner fleet on Google Kubernetes Engine
breadcr... |
https://docs.gitlab.com/topics/gitlab_runner_manager_performance | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/gitlab_runner_manager_performance.md | 2025-08-13 | doc/topics/runner_fleet_design_guides | [
"doc",
"topics",
"runner_fleet_design_guides"
] | gitlab_runner_manager_performance.md | Verify | Runner | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Optimize GitLab Runner manager pod performance | Optimize GitLab Runner Manager Pod performance in Kubernetes environments. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
To monitor and optimize GitLab Runner manager pod performance in Kubernetes environments, GitLab recommends
the following best practices. Apply them to identify performance bottlenecks and ... | ---
stage: Verify
group: Runner
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Optimize GitLab Runner Manager Pod performance in Kubernetes environments.
title: Optimize GitL... |
https://docs.gitlab.com/topics/upgrading_auto_deploy_dependencies | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/upgrading_auto_deploy_dependencies.md | 2025-08-13 | doc/topics/autodevops | [
"doc",
"topics",
"autodevops"
] | upgrading_auto_deploy_dependencies.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Upgrading deployments for newer Auto Deploy dependencies | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
[Auto Deploy](stages.md#auto-deploy) is a feature that deploys your application to a Kubernetes cluster.
It consists of several dependencies:
- [Auto Deploy template](https://gitlab.com/g... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Upgrading deployments for newer Auto Deploy dependencies
breadcrumbs:
- doc
- topics
- autodevo... |
https://docs.gitlab.com/topics/cicd_variables | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/cicd_variables.md | 2025-08-13 | doc/topics/autodevops | [
"doc",
"topics",
"autodevops"
] | cicd_variables.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | CI/CD variables | null |
Use CI/CD variables to set up the Auto DevOps domain, provide a custom
Helm chart, or scale your application.
## Build and deployment variables
Use these variables to customize and deploy your build.
<!-- markdownlint-disable MD056 -->
| **CI/CD variable** | **Description** |
|---------------... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: CI/CD variables
breadcrumbs:
- doc
- topics
- autodevops
---
Use CI/CD variables to set up th... |
https://docs.gitlab.com/topics/customize | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/customize.md | 2025-08-13 | doc/topics/autodevops | [
"doc",
"topics",
"autodevops"
] | customize.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Customize Auto DevOps | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can customize components of Auto DevOps to fit your needs. For example, you can:
- Add custom [buildpacks](#custom-buildpacks), [Dockerfiles](#custom-dockerfiles), and [Helm charts](#... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Customize Auto DevOps
breadcrumbs:
- doc
- topics
- autodevops
---
{{< details >}}
- Tier: F... |
https://docs.gitlab.com/topics/troubleshooting | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/troubleshooting.md | 2025-08-13 | doc/topics/autodevops | [
"doc",
"topics",
"autodevops"
] | troubleshooting.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Troubleshooting Auto DevOps | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The information in this documentation page describes common errors when using
Auto DevOps, and any available workarounds.
## Trace Helm commands
Set the CI/CD variable `TRACE` to any val... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Troubleshooting Auto DevOps
breadcrumbs:
- doc
- topics
- autodevops
---
{{< details >}}
- T... |
https://docs.gitlab.com/topics/upgrading_postgresql | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/upgrading_postgresql.md | 2025-08-13 | doc/topics/autodevops | [
"doc",
"topics",
"autodevops"
] | upgrading_postgresql.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Upgrading PostgreSQL for Auto DevOps | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
When `POSTGRES_ENABLED` is `true`, Auto DevOps provides an
[in-cluster PostgreSQL database](customize.md#postgresql-database-support) for your application.
The version of the chart used t... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Upgrading PostgreSQL for Auto DevOps
breadcrumbs:
- doc
- topics
- autodevops
---
{{< details... |
https://docs.gitlab.com/topics/stages | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/stages.md | 2025-08-13 | doc/topics/autodevops | [
"doc",
"topics",
"autodevops"
] | stages.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Stages of Auto DevOps | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The following sections describe the stages of [Auto DevOps](_index.md).
Read them carefully to understand how each one works.
## Auto Build
{{< alert type="note" >}}
Auto Build is not s... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Stages of Auto DevOps
breadcrumbs:
- doc
- topics
- autodevops
---
{{< details >}}
- Tier: F... |
https://docs.gitlab.com/topics/multiple_clusters_auto_devops | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/multiple_clusters_auto_devops.md | 2025-08-13 | doc/topics/autodevops | [
"doc",
"topics",
"autodevops"
] | multiple_clusters_auto_devops.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Multiple Kubernetes clusters for Auto DevOps | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
When using Auto DevOps, you can deploy different environments to different Kubernetes clusters.
The [Deploy Job template](https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Multiple Kubernetes clusters for Auto DevOps
breadcrumbs:
- doc
- topics
- autodevops
---
{{<... |
https://docs.gitlab.com/topics/requirements | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/requirements.md | 2025-08-13 | doc/topics/autodevops | [
"doc",
"topics",
"autodevops"
] | requirements.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Requirements for Auto DevOps | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Before enabling [Auto DevOps](_index.md), we recommend you to prepare it for
deployment. If you don't, you can use it to build and test your apps, and
then configure the deployment later.
... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Requirements for Auto DevOps
breadcrumbs:
- doc
- topics
- autodevops
---
{{< details >}}
- ... |
https://docs.gitlab.com/topics/autodevops | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/_index.md | 2025-08-13 | doc/topics/autodevops | [
"doc",
"topics",
"autodevops"
] | _index.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Auto DevOps | Automated DevOps, language detection, deployment, and customization. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Auto DevOps turns your code into production-ready applications without the usual configuration overhead.
The entire DevOps lifecycle is pre-configured using industry best practices. Start ... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Auto DevOps
description: Automated DevOps, language detection, deployment, and customization.
b... |
https://docs.gitlab.com/topics/prepare_deployment | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/prepare_deployment.md | 2025-08-13 | doc/topics/autodevops | [
"doc",
"topics",
"autodevops"
] | prepare_deployment.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Prepare Auto DevOps for deployment | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
If you enable Auto DevOps without setting the base domain and deployment
strategy, GitLab can't deploy your application directly. Therefore, we
recommend that you prepare them before enabl... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Prepare Auto DevOps for deployment
breadcrumbs:
- doc
- topics
- autodevops
---
{{< details >... |
https://docs.gitlab.com/topics/autodevops/auto_devops_with_eks | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/autodevops/auto_devops_with_eks.md | 2025-08-13 | doc/topics/autodevops/cloud_deployments | [
"doc",
"topics",
"autodevops",
"cloud_deployments"
] | auto_devops_with_eks.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Use Auto DevOps to deploy an application to Amazon Elastic Kubernetes Service (EKS) | null |
In this tutorial, we'll help you to get started with [Auto DevOps](../_index.md)
through an example of how to deploy an application to Amazon Elastic Kubernetes Service (EKS).
The tutorial uses the GitLab native Kubernetes integration, so you don't need
to create a Kubernetes cluster manually using the AWS console.
... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Use Auto DevOps to deploy an application to Amazon Elastic Kubernetes Service
(EKS)
breadcrum... |
https://docs.gitlab.com/topics/autodevops/auto_devops_with_ecs | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/autodevops/auto_devops_with_ecs.md | 2025-08-13 | doc/topics/autodevops/cloud_deployments | [
"doc",
"topics",
"autodevops",
"cloud_deployments"
] | auto_devops_with_ecs.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Use Auto DevOps to deploy to Amazon ECS | null |
You can choose to target AWS ECS as a deployment platform instead of using Kubernetes.
To get started on Auto DevOps to AWS ECS, you must add a specific CI/CD variable.
To do so, follow these steps:
1. On the left sidebar, select **Search or go to** and find your project.
1. Select **Settings > CI/CD**.
1. Expand *... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Use Auto DevOps to deploy to Amazon ECS
breadcrumbs:
- doc
- topics
- autodevops
- cloud_deploy... |
https://docs.gitlab.com/topics/autodevops/auto_devops_with_ec2 | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/autodevops/auto_devops_with_ec2.md | 2025-08-13 | doc/topics/autodevops/cloud_deployments | [
"doc",
"topics",
"autodevops",
"cloud_deployments"
] | auto_devops_with_ec2.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Use Auto DevOps to deploy to EC2 | null |
To use [Auto DevOps](../_index.md) to deploy to EC2:
1. Define [your AWS credentials as CI/CD variables](../../../ci/cloud_deployment/_index.md#authenticate-gitlab-with-aws).
1. In your `.gitlab-ci.yml` file, reference the `Auto-Devops.gitlab-ci.yml` template.
1. Define a job for the `build` stage named `build_artif... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Use Auto DevOps to deploy to EC2
breadcrumbs:
- doc
- topics
- autodevops
- cloud_deployments
-... |
https://docs.gitlab.com/topics/autodevops/auto_devops_with_gke | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/autodevops/auto_devops_with_gke.md | 2025-08-13 | doc/topics/autodevops/cloud_deployments | [
"doc",
"topics",
"autodevops",
"cloud_deployments"
] | auto_devops_with_gke.md | Deploy | Environments | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Use Auto DevOps to deploy an application to Google Kubernetes Engine | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
In this tutorial, we'll help you to get started with [Auto DevOps](../_index.md)
through an example of how to deploy an application to Google Kubernetes Engine (GKE).
You are using the Gi... | ---
stage: Deploy
group: Environments
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Use Auto DevOps to deploy an application to Google Kubernetes Engine
breadcrumbs:
- doc
- topic... |
https://docs.gitlab.com/topics/cron | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/_index.md | 2025-08-13 | doc/topics/cron | [
"doc",
"topics",
"cron"
] | _index.md | none | unassigned | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Cron | Schedule when jobs should run. |
Cron syntax is used to schedule when jobs should run.
You may need to use a cron syntax string to
create a [pipeline schedule](../../ci/pipelines/schedules.md),
or to prevent unintentional releases by setting a
[deploy freeze](../../user/project/releases/_index.md#prevent-unintentional-releases-by-setting-a-deploy-f... | ---
stage: none
group: unassigned
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Cron
description: Schedule when jobs should run.
breadcrumbs:
- doc
- topics
- cron
---
Cron synt... |
https://docs.gitlab.com/topics/repository | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/repository.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | repository.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Reduce repository size | To remove unwanted large files from a Git repository and reduce its storage size, use the filter-repo command. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
The size of a Git repository can significantly impact performance and storage costs.
It can differ slightly from one instance to another due to compression, housekeeping, and other factors... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: To remove unwanted large files from a Git repository and reduce its storage
size, use th... |
https://docs.gitlab.com/topics/git_rebase | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/git_rebase.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | git_rebase.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Rebase and resolve merge conflicts | Introduction to Git rebase and force push, methods to resolve merge conflicts through the command line. |
Git rebase combines changes from one branch into another by moving your commits to the
tip of the target branch. This action:
- Updates branches with the latest code from the target branch.
- Maintains a clean, linear commit history for easier debugging and code reviews.
- Resolves [merge conflicts](../../user/proje... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Introduction to Git rebase and force push, methods to resolve merge conflicts
through th... |
https://docs.gitlab.com/topics/forks | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/forks.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | forks.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Update a fork | Fork a Git repository when you want to contribute changes back to an upstream repository you don't have permission to contribute to directly. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
A fork is a personal copy of the repository and all its branches, which you create
in a namespace of your choice. You can use forks to propose changes to another project
that you don't hav... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Fork a Git repository when you want to contribute changes back to an
upstream repository... |
https://docs.gitlab.com/topics/merge | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/merge.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | merge.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Merge your branch into the main branch | null |
After you have [created a branch](branch.md), made the required changes, and [committed them locally](commit.md),
you [push your branch](commit.md#send-changes-to-gitlab) and its commits to GitLab.
In the response to the `git push`, GitLab provides a direct link to create the merge request. For example:
```plaintex... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Merge your branch into the main branch
breadcrumbs:
- doc
- topics
- git
---
After you have [c... |
https://docs.gitlab.com/topics/stash | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/stash.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | stash.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Stash changes for later | null |
Use `git stash` when you want to change to a different branch, and you want to store changes that are not ready to be
committed.
- To stash uncommitted changes without a message:
```shell
git stash
```
- To stash uncommitted changes with a message:
```shell
git stash save "this is a message to display o... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Stash changes for later
breadcrumbs:
- doc
- topics
- git
---
Use `git stash` when you want to... |
https://docs.gitlab.com/topics/branch | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/branch.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | branch.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Create a Git branch for your changes | null |
A branch is a copy of the files in the repository at the time you create the branch.
You can work in your branch without affecting other branches. When
you're ready to add your changes to the main codebase, you can merge your branch into
the default branch, for example, `main`.
Use branches when you:
- Want to add ... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Create a Git branch for your changes
breadcrumbs:
- doc
- topics
- git
---
A branch is a copy ... |
https://docs.gitlab.com/topics/troubleshooting_git | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/troubleshooting_git.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | troubleshooting_git.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Troubleshooting Git | Tips to resolve Git issues. |
Sometimes things don't work the way they should or as you might expect when
you're using Git. Here are some tips on troubleshooting and resolving issues
with Git.
## Debugging
When troubleshooting problems with Git, try these debugging techniques.
### Use a custom SSH key for a Git command
```shell
GIT_SSH_COMMAN... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Tips to resolve Git issues.
title: Troubleshooting Git
breadcrumbs:
- doc
- topics
- git
-... |
https://docs.gitlab.com/topics/commands | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/commands.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | commands.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Common Git commands | null |
Git commands save you time throughout your development workflow. This reference page contains
frequently used commands for common tasks such as code changes, branch management,
and history review. Each command section provides the exact syntax, practical examples,
and links to additional documentation.
## `git add`
... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Common Git commands
breadcrumbs:
- doc
- topics
- git
---
Git commands save you time throughou... |
https://docs.gitlab.com/topics/add_files | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/add_files.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | add_files.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Add files to your branch | Add, commit, and push a file to your Git repository using the command line. |
Use Git to add files to a branch in your local repository.
This action creates a snapshot of the file for your
next commit and starts version control monitoring.
When you add files with Git, you:
- Prepare content for version control tracking.
- Create a record of file additions and modifications.
- Preserve file hi... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Add, commit, and push a file to your Git repository using the command
line.
title: Add f... |
https://docs.gitlab.com/topics/advanced | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/advanced.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | advanced.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Advanced Git operations | Rebase, cherry-pick, revert changes, repository, and file management. |
Advanced Git operations help you perform tasks to maintain and manage your code.
They are more complex actions that go beyond [basic Git operations](basics.md).
These operations enable you to:
- Rewrite commit history.
- Revert and undo changes.
- Manage remote repository connections.
They provide you with the foll... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Rebase, cherry-pick, revert changes, repository, and file management.
title: Advanced Git ... |
https://docs.gitlab.com/topics/basics | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/basics.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | basics.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Basic Git operations | Create a project, clone a repository, stash changes, branches, and forks. |
Basic Git operations help you to manage your Git repositories and to make changes to your code.
They provide you with the following benefits:
- Version control: Maintain a history of your project to track changes and revert to previous versions if needed.
- Collaboration: Enable collaboration and makes it easier to ... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Create a project, clone a repository, stash changes, branches, and forks.
title: Basic Git... |
https://docs.gitlab.com/topics/project | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/project.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | project.md | Tenant Scale | Organizations | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Create a project with `git push` | null |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
You can use `git push` to add a local project repository to GitLab. After you add a repository,
GitLab creates your project in your chosen namespace.
{{< alert type="note" >}}
You cannot... | ---
stage: Tenant Scale
group: Organizations
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Create a project with `git push`
breadcrumbs:
- doc
- topics
- git
---
{{< details >}}... |
https://docs.gitlab.com/topics/git | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/_index.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | _index.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Use Git | Common Git commands and workflows. |
Git is a [free and open source](https://git-scm.com/about/free-and-open-source)
distributed version control system. It handles projects of all sizes quickly and
efficiently, and provides support for rolling back changes when needed.
GitLab is built on top of (and with) Git, and provides you a Git-based, fully-integr... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Common Git commands and workflows.
title: Use Git
breadcrumbs:
- doc
- topics
- git
---
... |
https://docs.gitlab.com/topics/undo | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/undo.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | undo.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Revert and undo changes | null |
Working with Git involves experimentation and iteration. Mistakes happen during development,
and sometimes you need to reverse changes. Git gives you control over your code history
with features to undo changes at any point in your
[Git workflow](get_started.md#understand-the-git-workflow).
Recover from accidental c... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
title: Revert and undo changes
breadcrumbs:
- doc
- topics
- git
---
Working with Git involves experi... |
https://docs.gitlab.com/topics/file_management | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/file_management.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | file_management.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | File management | Common commands and workflows. |
Git provides file management capabilities that help you to track changes,
collaborate with others, and manage large files efficiently.
## File history
Use `git log` to view a file's complete history and understand how it has changed over time.
The file history shows you:
- The author of each change.
- The date and... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Common commands and workflows.
title: File management
breadcrumbs:
- doc
- topics
- git
--... |
https://docs.gitlab.com/topics/clone | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/clone.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | clone.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Clone a Git repository to your local computer | Learn how to clone Git repositories from a GitLab server using different protocols (SSH or HTTPS) and various IDEs. |
You can clone a Git repository to your local computer. This action creates a copy of the repository and
establishes a connection that synchronizes changes between your computer and the GitLab server.
This connection requires you to add credentials.
You can either [clone with SSH](#clone-with-ssh) or [clone with HTTPS... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Learn how to clone Git repositories from a GitLab server using different
protocols (SSH ... |
https://docs.gitlab.com/topics/get_started | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/get_started.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | get_started.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Get started with Git | Work with the Git version control system. |
Git is a version control system you use to track changes to your code and collaborate with others.
GitLab is a web-based Git repository manager that provides CI/CD and other features to help you
manage your software development lifecycle.
You can use GitLab without knowing Git.
However, it is advantageous to underst... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Work with the Git version control system.
title: Get started with Git
breadcrumbs:
- doc
-... |
https://docs.gitlab.com/topics/commit | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/commit.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | commit.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Stage, commit, and push changes | Common commands and workflows. |
When you make changes to files in a repository, Git tracks the changes
against the most recent version of the checked out branch. You can use
Git commands to review and commit your changes to the branch, and push
your work to GitLab.
## Add and commit local changes
When you're ready to write your changes to the bra... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Common commands and workflows.
title: Stage, commit, and push changes
breadcrumbs:
- doc
-... |
https://docs.gitlab.com/topics/cherry_pick | https://gitlab.com/gitlab-org/gitlab/-/tree/master/doc/topics/cherry_pick.md | 2025-08-13 | doc/topics/git | [
"doc",
"topics",
"git"
] | cherry_pick.md | Create | Source Code | To determine the technical writer assigned to the Stage/Group associated with this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments | Cherry-pick changes with Git | Cherry-pick a Git commit when you want to add a single commit from one branch to another. |
{{< details >}}
- Tier: Free, Premium, Ultimate
- Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated
{{< /details >}}
Use `git cherry-pick` to apply the changes from a specific commit to your current
working branch. Use this command to:
- Backport bug fixes from the default branch to previous release bra... | ---
stage: Create
group: Source Code
info: To determine the technical writer assigned to the Stage/Group associated with
this page, see https://handbook.gitlab.com/handbook/product/ux/technical-writing/#assignments
description: Cherry-pick a Git commit when you want to add a single commit from one
branch to another... |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.