# Review Apps
> 原文：[https://docs.gitlab.com/ee/ci/review_apps/](https://docs.gitlab.com/ee/ci/review_apps/)
* [Introduction](#introduction)
* [How Review Apps work](#how-review-apps-work)
* [Configuring Review Apps](#configuring-review-apps)
* [Enable Review Apps button](#enable-review-apps-button)
* [Review Apps auto-stop](#review-apps-auto-stop)
* [Review Apps examples](#review-apps-examples)
* [Route Maps](#route-maps)
* [Route Maps example](#route-maps-example)
* [Visual Reviews](#visual-reviews-starter)
* [Configuring Visual Reviews](#configuring-visual-reviews)
* [Determining merge request ID](#determining-merge-request-id)
* [Visual Reviews in private or internal projects](#visual-reviews-in-private-or-internal-projects)
* [Using Visual Reviews](#using-visual-reviews)
* [Limitations](#limitations)
# Review Apps[](#review-apps "Permalink")
版本歷史
* 在 GitLab 8.12 中[引入](https://gitlab.com/gitlab-org/gitlab-foss/-/issues/21971) . 在 GitLab 8.13 和 8.14 中進行了進一步添加.
* 受到[Heroku 的 Review Apps 的](https://devcenter.heroku.com/articles/github-integration-review-apps)啟發，該[應用程序](https://devcenter.heroku.com/articles/github-integration-review-apps)本身也受到[Fourchette 的](https://github.com/rainforestapp/fourchette)啟發.
Review Apps 是一種協作工具，可消除提供展示產品更改環境的艱苦工作.
## Introduction[](#introduction "Permalink")
查看應用程序：
* 通過為合并請求擴展動態環境，提供功能分支中所做更改的自動實時預覽.
* 允許設計人員和產品經理查看您的更改，而無需檢出分支機構并在沙盒環境中運行您的更改.
* 與[GitLab DevOps LifeCycle](../../README.html#the-entire-devops-lifecycle)完全集成.
* 允許您將更改部署到任何地方.
[](img/continuous-delivery-review-apps.svg)
在上面的示例中：
* 每次將提交推送到`topic branch`時，都會構建一個 Review App.
* 審閱者在通過第三次審閱之前未通過兩次審閱.
* 審核通過后， `topic branch`將合并到`master` `topic branch`中，并在該`topic branch`中進行部署.
* 在階段中獲得批準后，已合并到`master`中的更改將部署到生產中.
## How Review Apps work[](#how-review-apps-work "Permalink")
Review App 是分支與[環境](../environments/index.html)的映射. 通過與分支相關的[合并請求](../../user/project/merge_requests.html)上的鏈接，可以訪問 Review App.
以下是動態設置環境的合并請求的示例.
[](img/review_apps_preview_in_mr.png)
在此示例中，分支為：
* 成功建立.
* 通過單擊" **查看應用程序"**按鈕可以到達的動態環境中進行部署.
將 Review Apps 添加到您的工作流后，您將遵循分支的 Git 流. 那是：
1. 推送一個分支，讓 Runner 根據動態環境作業的`script`定義部署 Review App.
2. 等待 Runner 構建和部署您的 Web 應用程序.
3. 單擊合并請求中與分支相關的鏈接，以實時查看更改.
## Configuring Review Apps[](#configuring-review-apps "Permalink")
Review Apps 建立在[動態環境上](../environments/index.html#configuring-dynamic-environments) ，可讓您為每個分支動態創建一個新環境.
配置 Review Apps 的過程如下：
1. 設置基礎結構以托管和部署 Review Apps（請查看下面的[示例](#review-apps-examples) ）.
2. [安裝](https://docs.gitlab.com/runner/install/)并[配置](https://docs.gitlab.com/runner/commands/) Runner 以進行部署.
3. 在`.gitlab-ci.yml`中設置一個作業，該作業使用[預定義的 CI 環境變量](../variables/README.html) `${CI_COMMIT_REF_NAME}`創建動態環境并將其限制為僅在分支上運行. 或者，您可以通過為項目[啟用審閱應用程序](#enable-review-apps-button)來獲得此工作的 YML 模板.
4. （可選）設置一個作業，以[手動停止](../environments/index.html#stopping-an-environment) Review Apps.
### Enable Review Apps button[](#enable-review-apps-button "Permalink")
在 GitLab 12.8 中[引入](https://gitlab.com/gitlab-org/gitlab/-/issues/118844) .
為項目配置 Review Apps 時，如上所述，您需要向`.gitlab-ci.yml`添加新作業. 為此，如果您正在使用 Kubernetes，則可以單擊**Enable Review Apps**按鈕，GitLab 會提示您一個模板代碼塊，您可以將該模板代碼塊復制并粘貼到`.gitlab-ci.yml`作為起點. 為此：
1. 轉到要為其創建 Review App 作業的項目.
2. 從左側導航欄中，轉到**運營** > **環境** .
3. 單擊**啟用審閱應用程序**按鈕. 如果您對該項目具有開發人員或更高[權限，則](../../user/permissions.html)可以使用它.
4. 復制提供的代碼段并將其粘貼到您的`.gitlab-ci.yml`文件中：
[](img/enable_review_app_v12_8.png)
5. 可以根據自己的需要隨意調整此模板.
## Review Apps auto-stop[](#review-apps-auto-stop "Permalink")
了解如何在給定的時間段后將[Review Apps 環境配置為過期并自動停止](../environments/index.html#environments-auto-stop) .
## Review Apps examples[](#review-apps-examples "Permalink")
以下是演示 Review App 配置的示例項目：
* [NGINX](https://gitlab.com/gitlab-examples/review-apps-nginx).
* [OpenShift](https://gitlab.com/gitlab-examples/review-apps-openshift).
評論應用的其他示例：
* [Cloud Native Development with GitLab](https://www.youtube.com/watch?v=jfIyQEwrocw).
* [Review Apps for Android](https://about.gitlab.com/blog/2020/05/06/how-to-create-review-apps-for-android-with-gitlab-fastlane-and-appetize-dot-io/).
## Route Maps[](#route-maps "Permalink")
Introduced in GitLab 8.17\. In GitLab 11.5, the file links are available in the merge request widget.
借助路線圖，您可以直接從源文件進入為 Review Apps 定義的[環境中的](../environments/index.html)公共頁面.
設置完成后，合并請求小部件中的審閱應用程序鏈接可以直接將您帶到更改的頁面，從而使預覽建議的修改變得更加輕松快捷.
配置路由圖涉及到告訴 GitLab 使用路由圖如何將存儲庫中文件的路徑映射到網站上的頁面路徑. 設置后，GitLab 將**在" ..."**按鈕**上**顯示" **視圖"** ，這將帶您進入直接從合并請求更改的頁面.
要設置路線圖，請在資源庫中的`.gitlab/route-map.yml`添加一個文件，其中包含一個 YAML 數組，該數組將`source`路徑（資源庫中）映射到`public`路徑（網站上）.
### Route Maps example[](#route-maps-example "Permalink")
以下是[Middleman](https://middlemanapp.com)路線圖的示例， [Middleman](https://middlemanapp.com)是用于構建[GitLab 網站](https://about.gitlab.com)的靜態站點生成器（SSG），是從其[在 GitLab.com 上的項目](https://gitlab.com/gitlab-com/www-gitlab-com)部署的：
```
# Team data
- source: 'data/team.yml' # data/team.yml
public: 'team/' # team/
# Blogposts
- source: /source\/posts\/([0-9]{4})-([0-9]{2})-([0-9]{2})-(.+?)\..*/ # source/posts/2017-01-30-around-the-world-in-6-releases.html.md.erb
public: '\1/\2/\3/\4/' # 2017/01/30/around-the-world-in-6-releases/
# HTML files
- source: /source\/(.+?\.html).*/ # source/index.html.haml
public: '\1' # index.html
# Other files
- source: /source\/(.*)/ # source/images/blogimages/around-the-world-in-6-releases-cover.png
public: '\1' # images/blogimages/around-the-world-in-6-releases-cover.png
```
映射定義為根 YAML 數組中的條目，并以`-`前綴標識. 在一個條目中，有一個帶有兩個鍵的哈希映射：
* `source`
* 完全匹配的字符串，以`'`開頭和結尾.
* 正則表達式，以`/`開頭和結尾，用于模式匹配：
* 正則表達式需要匹配整個源路徑-隱含`^`和`$`錨.
* 可以包括由`()`表示的捕獲組，這些捕獲組可以在`public`路徑中引用.
* 斜杠（ `/` ）可以但不必轉為`\/` .
* 文字句號（ `.` ）應轉為`\.` .
* `public` ，一個以`'`開頭和結尾的字符串.
* 可以包含`\N`表達式，從`source`正則表達式開始，以其出現的順序引用捕獲組，從`\1`開始.
通過找到與之匹配的第一個`source`表達式，然后返回相應的`public`路徑，并用`()`捕獲組的值替換`\N`表達式，來確定源路徑的`public`路徑.
在上面的示例中，按照定義順序對映射進行求值的事實用于確保`source/index.html.haml`將匹配`/source\/(.+?\.html).*/`而不是`/source\/(.*)/` ，并將導致`index.html`的公共路徑，而不是`index.html.haml` .
設置路由映射后，它將在以下位置生效：
* 在合并請求小部件中. 該：
* **"查看應用程序"**按鈕將帶您進入`.gitlab-ci.yml`設置的環境 URL.
* 下拉菜單將列出路線圖中的前 5 個匹配項，但如果有 5 個以上可用項，則可以對其進行過濾.
[](img/view_on_mr_widget.png)
* 在差異中進行合并請求，比較或提交.
[](img/view_on_env_mr.png)
* 在 Blob 文件視圖中.
[](img/view_on_env_blob.png)
## Visual Reviews[](#visual-reviews-starter "Permalink")
[Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/10761) in GitLab Starter 12.0.
使用視覺評論，您可以向您的評論應用程序提供反饋表單，以便評論者可以將評論直接從應用程序發布回產生評論應用程序的合并請求.
### Configuring Visual Reviews[](#configuring-visual-reviews "Permalink")
確保啟用了`anonymous_visual_review_feedback`功能標志. 管理員可以使用 Rails 控制臺啟用，如下所示：
```
Feature.enable(:anonymous_visual_review_feedback)
```
反饋表單是通過您添加到 Review App 中頁面的腳本提供的. 如果您擁有該項目的[開發人員權限](../../user/permissions.html) ，則可以通過單擊合并請求的" **管道"**部分中的" **查看"**按鈕來訪問它. 如果在項目中配置了[路線圖，](#route-maps)則表格模式還將顯示更改頁面的下拉列表.
[](img/review_button.png)
提供的腳本應添加到應用程序的`<head>`中，并由一些項目和合并請求特定的值組成. 看起來是這樣的：
```
<script data-project-id='11790219'
data-merge-request-id='1'
data-mr-url='https://gitlab.example.com'
data-project-path='sarah/review-app-tester'
data-require-auth='true'
id='review-app-toolbar-script'
src='https://gitlab.example.com/assets/webpack/visual_review_toolbar.js'>
</script>
```
理想情況下，創建每個審閱應用程序時，應在運行時使用[環境變量](../variables/predefined_variables.html)替換這些值：
* `data-project-id`是項目 ID，可通過`CI_PROJECT_ID`變量找到.
* `data-merge-request-id`是合并請求 ID，可以通過`CI_MERGE_REQUEST_IID`變量找到它. `CI_MERGE_REQUEST_IID`僅當[`only: [merge_requests]`](../merge_request_pipelines/index.html)被使用并且在創建合并請求.
* `data-mr-url`是 GitLab 實例的 URL，并且對于所有評論應用程序都是相同的.
* `data-project-path`是項目的路徑，可以通過`CI_PROJECT_PATH`找到.
* `data-require-auth`對于公共項目是可選的，但對于[私有和內部](#visual-reviews-in-private-or-internal-projects)項目則是必需[的](#visual-reviews-in-private-or-internal-projects) . 如果將其設置為`true` ，則將要求用戶輸入其[個人訪問令牌，](../../user/profile/personal_access_tokens.html)而不是其名稱和電子郵件.
* `id`始終是`review-app-toolbar-script` ，您無需更改它.
* `src`是審閱工具欄腳本的源代碼，該腳本位于相應的 GitLab 實例中，并且對于所有審閱應用程序都是相同的.
例如，在 Ruby 應用程序中，您需要具有以下腳本：
```
<script data-project-id="ENV['CI_PROJECT_ID']"
data-merge-request-id="ENV['CI_MERGE_REQUEST_IID']"
data-mr-url='https://gitlab.example.com'
data-project-path="ENV['CI_PROJECT_PATH']"
id='review-app-toolbar-script'
src='https://gitlab.example.com/assets/webpack/visual_review_toolbar.js'>
</script>
```
然后，當通過 GitLab CI / CD 部署您的應用程序時，這些變量應替換為其實際值.
### Determining merge request ID[](#determining-merge-request-id "Permalink")
視覺審核工具從`script` HTML 標簽中包含的`data-merge-request-id`數據屬性中檢索合并請求 ID，該`script` HTML 標簽用于將視覺審核工具添加到您的審核應用中.
確定合并請求以鏈接到可視評論應用程序的 ID 后，您可以通過以下任一方式提供 ID：
* 通過應用程序的數據屬性`data-merge-request-id`在 script 標簽中對其進行硬編碼.
* 在應用程序的構建過程中動態添加`data-merge-request-id`值.
* 通過應用中的視覺查看表單手動提供.
### Visual Reviews in private or internal projects[](#visual-reviews-in-private-or-internal-projects "Permalink")
在 GitLab 12.10 中[引入](https://gitlab.com/gitlab-org/gitlab/-/issues/42750#note_317271120) .
要對私有項目和內部項目啟用可視化審閱，請將[`data-require-auth`變量設置](#configuring-visual-reviews)為`true` . 啟用后，用戶必須輸入具有`api`范圍的[個人訪問令牌](../../user/profile/personal_access_tokens.html) ，然后才能提交反饋.
### Using Visual Reviews[](#using-visual-reviews "Permalink")
在為"評論"應用程序[啟用](#configuring-visual-reviews) "視覺評論"后，"視覺評論"反饋表單將覆蓋在應用程序頁面的右下角.
[](img/toolbar_feeback_form.png)
要使用反饋表：
1. 對視覺評論發表評論. 您可以使用合并請求注釋中所有可用的[Markdown 注釋](../../user/markdown.html) .
2. 如果`data-require-auth`為`true` ，則必須輸入[個人訪問令牌](../../user/profile/personal_access_tokens.html) . 否則，您必須輸入您的姓名，以及可選的電子郵件地址.
3. 最后，點擊**發送反饋** .
在視覺檢查框中做出評論并提交評論后，評論將自動出現在相應的合并請求中.
## Limitations[](#limitations "Permalink")
Review App 限制與[環境限制](../environments/index.html#limitations)相同.
- GitLab Docs
- Installation
- Requirements
- GitLab cloud native Helm Chart
- Install GitLab with Docker
- Installation from source
- Install GitLab on Microsoft Azure
- Installing GitLab on Google Cloud Platform
- Installing GitLab on Amazon Web Services (AWS)
- Analytics
- Code Review Analytics
- Productivity Analytics
- Value Stream Analytics
- Kubernetes clusters
- Adding and removing Kubernetes clusters
- Adding EKS clusters
- Adding GKE clusters
- Group-level Kubernetes clusters
- Instance-level Kubernetes clusters
- Canary Deployments
- Cluster Environments
- Deploy Boards
- GitLab Managed Apps
- Crossplane configuration
- Cluster management project (alpha)
- Kubernetes Logs
- Runbooks
- Serverless
- Deploying AWS Lambda function using GitLab CI/CD
- Securing your deployed applications
- Groups
- Contribution Analytics
- Custom group-level project templates
- Epics
- Manage epics
- Group Import/Export
- Insights
- Issues Analytics
- Iterations
- Public access
- SAML SSO for GitLab.com groups
- SCIM provisioning using SAML SSO for GitLab.com groups
- Subgroups
- Roadmap
- Projects
- GitLab Secure
- Security Configuration
- Container Scanning
- Dependency Scanning
- Dependency List
- Static Application Security Testing (SAST)
- Secret Detection
- Dynamic Application Security Testing (DAST)
- GitLab Security Dashboard
- Offline environments
- Standalone Vulnerability pages
- Security scanner integration
- Badges
- Bulk editing issues and merge requests at the project level
- Code Owners
- Compliance
- License Compliance
- Compliance Dashboard
- Create a project
- Description templates
- Deploy Keys
- Deploy Tokens
- File finder
- Project integrations
- Integrations
- Atlassian Bamboo CI Service
- Bugzilla Service
- Custom Issue Tracker service
- Discord Notifications service
- Enabling emails on push
- GitHub project integration
- Hangouts Chat service
- Atlassian HipChat
- Irker IRC Gateway
- GitLab Jira integration
- Mattermost Notifications Service
- Mattermost slash commands
- Microsoft Teams service
- Mock CI Service
- Prometheus integration
- Redmine Service
- Slack Notifications Service
- Slack slash commands
- GitLab Slack application
- Webhooks
- YouTrack Service
- Insights
- Issues
- Crosslinking Issues
- Design Management
- Confidential issues
- Due dates
- Issue Boards
- Issue Data and Actions
- Labels
- Managing issues
- Milestones
- Multiple Assignees for Issues
- Related issues
- Service Desk
- Sorting and ordering issue lists
- Issue weight
- Associate a Zoom meeting with an issue
- Merge requests
- Allow collaboration on merge requests across forks
- Merge Request Approvals
- Browser Performance Testing
- How to create a merge request
- Cherry-pick changes
- Code Quality
- Load Performance Testing
- Merge Request dependencies
- Fast-forward merge requests
- Merge when pipeline succeeds
- Merge request conflict resolution
- Reverting changes
- Reviewing and managing merge requests
- Squash and merge
- Merge requests versions
- Draft merge requests
- Members of a project
- Migrating projects to a GitLab instance
- Import your project from Bitbucket Cloud to GitLab
- Import your project from Bitbucket Server to GitLab
- Migrating from ClearCase
- Migrating from CVS
- Import your project from FogBugz to GitLab
- Gemnasium
- Import your project from GitHub to GitLab
- Project importing from GitLab.com to your private GitLab instance
- Import your project from Gitea to GitLab
- Import your Jira project issues to GitLab
- Migrating from Perforce Helix
- Import Phabricator tasks into a GitLab project
- Import multiple repositories by uploading a manifest file
- Import project from repo by URL
- Migrating from SVN to GitLab
- Migrating from TFVC to Git
- Push Options
- Releases
- Repository
- Branches
- Git Attributes
- File Locking
- Git file blame
- Git file history
- Repository mirroring
- Protected branches
- Protected tags
- Push Rules
- Reduce repository size
- Signing commits with GPG
- Syntax Highlighting
- GitLab Web Editor
- Web IDE
- Requirements Management
- Project settings
- Project import/export
- Project access tokens (Alpha)
- Share Projects with other Groups
- Snippets
- Static Site Editor
- Wiki
- Project operations
- Monitor metrics for your CI/CD environment
- Set up alerts for Prometheus metrics
- Embedding metric charts within GitLab-flavored Markdown
- Embedding Grafana charts
- Using the Metrics Dashboard
- Dashboard YAML properties
- Metrics dashboard settings
- Panel types for dashboards
- Using Variables
- Templating variables for metrics dashboards
- Prometheus Metrics library
- Monitoring AWS Resources
- Monitoring HAProxy
- Monitoring Kubernetes
- Monitoring NGINX
- Monitoring NGINX Ingress Controller
- Monitoring NGINX Ingress Controller with VTS metrics
- Alert Management
- Error Tracking
- Tracing
- Incident Management
- GitLab Status Page
- Feature Flags
- GitLab CI/CD
- GitLab CI/CD pipeline configuration reference
- GitLab CI/CD include examples
- Introduction to CI/CD with GitLab
- Getting started with GitLab CI/CD
- How to enable or disable GitLab CI/CD
- Using SSH keys with GitLab CI/CD
- Migrating from CircleCI
- Migrating from Jenkins
- Auto DevOps
- Getting started with Auto DevOps
- Requirements for Auto DevOps
- Customizing Auto DevOps
- Stages of Auto DevOps
- Upgrading PostgreSQL for Auto DevOps
- Cache dependencies in GitLab CI/CD
- GitLab ChatOps
- Cloud deployment
- Docker integration
- Building Docker images with GitLab CI/CD
- Using Docker images
- Building images with kaniko and GitLab CI/CD
- GitLab CI/CD environment variables
- Predefined environment variables reference
- Where variables can be used
- Deprecated GitLab CI/CD variables
- Environments and deployments
- Protected Environments
- GitLab CI/CD Examples
- Test a Clojure application with GitLab CI/CD
- Using Dpl as deployment tool
- Testing a Phoenix application with GitLab CI/CD
- End-to-end testing with GitLab CI/CD and WebdriverIO
- DevOps and Game Dev with GitLab CI/CD
- Deploy a Spring Boot application to Cloud Foundry with GitLab CI/CD
- How to deploy Maven projects to Artifactory with GitLab CI/CD
- Testing PHP projects
- Running Composer and NPM scripts with deployment via SCP in GitLab CI/CD
- Test and deploy Laravel applications with GitLab CI/CD and Envoy
- Test and deploy a Python application with GitLab CI/CD
- Test and deploy a Ruby application with GitLab CI/CD
- Test and deploy a Scala application to Heroku
- GitLab CI/CD for external repositories
- Using GitLab CI/CD with a Bitbucket Cloud repository
- Using GitLab CI/CD with a GitHub repository
- GitLab Pages
- GitLab Pages
- GitLab Pages domain names, URLs, and baseurls
- Create a GitLab Pages website from scratch
- Custom domains and SSL/TLS Certificates
- GitLab Pages integration with Let's Encrypt
- GitLab Pages Access Control
- Exploring GitLab Pages
- Incremental Rollouts with GitLab CI/CD
- Interactive Web Terminals
- Optimizing GitLab for large repositories
- Metrics Reports
- CI/CD pipelines
- Pipeline Architecture
- Directed Acyclic Graph
- Multi-project pipelines
- Parent-child pipelines
- Pipelines for Merge Requests
- Pipelines for Merged Results
- Merge Trains
- Job artifacts
- Pipeline schedules
- Pipeline settings
- Triggering pipelines through the API
- Review Apps
- Configuring GitLab Runners
- GitLab CI services examples
- Using MySQL
- Using PostgreSQL
- Using Redis
- Troubleshooting CI/CD
- GitLab Package Registry
- GitLab Container Registry
- Dependency Proxy
- GitLab Composer Repository
- GitLab Conan Repository
- GitLab Maven Repository
- GitLab NPM Registry
- GitLab NuGet Repository
- GitLab PyPi Repository
- API Docs
- API resources
- .gitignore API
- GitLab CI YMLs API
- Group and project access requests API
- Appearance API
- Applications API
- Audit Events API
- Avatar API
- Award Emoji API
- Project badges API
- Group badges API
- Branches API
- Broadcast Messages API
- Project clusters API
- Group clusters API
- Instance clusters API
- Commits API
- Container Registry API
- Custom Attributes API
- Dashboard annotations API
- Dependencies API
- Deploy Keys API
- Deployments API
- Discussions API
- Dockerfiles API
- Environments API
- Epics API
- Events
- Feature Flags API
- Feature flag user lists API
- Freeze Periods API
- Geo Nodes API
- Group Activity Analytics API
- Groups API
- Import API
- Issue Boards API
- Group Issue Boards API
- Issues API
- Epic Issues API
- Issues Statistics API
- Jobs API
- Keys API
- Labels API
- Group Labels API
- License
- Licenses API
- Issue links API
- Epic Links API
- Managed Licenses API
- Markdown API
- Group and project members API
- Merge request approvals API
- Merge requests API
- Project milestones API
- Group milestones API
- Namespaces API
- Notes API
- Notification settings API
- Packages API
- Pages domains API
- Pipeline schedules API
- Pipeline triggers API
- Pipelines API
- Project Aliases API
- Project import/export API
- Project repository storage moves API
- Project statistics API
- Project templates API
- Projects API
- Protected branches API
- Protected tags API
- Releases API
- Release links API
- Repositories API
- Repository files API
- Repository submodules API
- Resource label events API
- Resource milestone events API
- Resource weight events API
- Runners API
- SCIM API
- Search API
- Services API
- Application settings API
- Sidekiq Metrics API
- Snippets API
- Project snippets
- Application statistics API
- Suggest Changes API
- System hooks API
- Tags API
- Todos API
- Users API
- Project-level Variables API
- Group-level Variables API
- Version API
- Vulnerabilities API
- Vulnerability Findings API
- Wikis API
- GraphQL API
- Getting started with GitLab GraphQL API
- GraphQL API Resources
- API V3 to API V4
- Validate the .gitlab-ci.yml (API)
- User Docs
- Abuse reports
- User account
- Active sessions
- Deleting a User account
- Permissions
- Personal access tokens
- Profile preferences
- Threads
- GitLab and SSH keys
- GitLab integrations
- Git
- GitLab.com settings
- Infrastructure as code with Terraform and GitLab
- GitLab keyboard shortcuts
- GitLab Markdown
- AsciiDoc
- GitLab Notification Emails
- GitLab Quick Actions
- Autocomplete characters
- Reserved project and group names
- Search through GitLab
- Advanced Global Search
- Advanced Syntax Search
- Time Tracking
- GitLab To-Do List
- Administrator Docs
- Reference architectures
- Reference architecture: up to 1,000 users
- Reference architecture: up to 2,000 users
- Reference architecture: up to 3,000 users
- Reference architecture: up to 5,000 users
- Reference architecture: up to 10,000 users
- Reference architecture: up to 25,000 users
- Reference architecture: up to 50,000 users
- Troubleshooting a reference architecture set up
- Working with the bundled Consul service
- Configuring PostgreSQL for scaling
- Configuring GitLab application (Rails)
- Load Balancer for multi-node GitLab
- Configuring a Monitoring node for Scaling and High Availability
- NFS
- Working with the bundled PgBouncer service
- Configuring Redis for scaling
- Configuring Sidekiq
- Admin Area settings
- Continuous Integration and Deployment Admin settings
- Custom instance-level project templates
- Diff limits administration
- Enable and disable GitLab features deployed behind feature flags
- Geo nodes Admin Area
- GitLab Pages administration
- Health Check
- Job logs
- Labels administration
- Log system
- PlantUML & GitLab
- Repository checks
- Repository storage paths
- Repository storage types
- Account and limit settings
- Service templates
- System hooks
- Changing your time zone
- Uploads administration
- Abuse reports
- Activating and deactivating users
- Audit Events
- Blocking and unblocking users
- Broadcast Messages
- Elasticsearch integration
- Gitaly
- Gitaly Cluster
- Gitaly reference
- Monitoring GitLab
- Monitoring GitLab with Prometheus
- Performance Bar
- Usage statistics
- Object Storage
- Performing Operations in GitLab
- Cleaning up stale Redis sessions
- Fast lookup of authorized SSH keys in the database
- Filesystem Performance Benchmarking
- Moving repositories managed by GitLab
- Run multiple Sidekiq processes
- Sidekiq MemoryKiller
- Switching to Puma
- Understanding Unicorn and unicorn-worker-killer
- User lookup via OpenSSH's AuthorizedPrincipalsCommand
- GitLab Package Registry administration
- GitLab Container Registry administration
- Replication (Geo)
- Geo database replication
- Geo with external PostgreSQL instances
- Geo configuration
- Using a Geo Server
- Updating the Geo nodes
- Geo with Object storage
- Docker Registry for a secondary node
- Geo for multiple nodes
- Geo security review (Q&A)
- Location-aware Git remote URL with AWS Route53
- Tuning Geo
- Removing secondary Geo nodes
- Geo data types support
- Geo Frequently Asked Questions
- Geo Troubleshooting
- Geo validation tests
- Disaster Recovery (Geo)
- Disaster recovery for planned failover
- Bring a demoted primary node back online
- Automatic background verification
- Rake tasks
- Back up and restore GitLab
- Clean up
- Namespaces
- Maintenance Rake tasks
- Geo Rake Tasks
- GitHub import
- Import bare repositories
- Integrity check Rake task
- LDAP Rake tasks
- Listing repository directories
- Praefect Rake tasks
- Project import/export administration
- Repository storage Rake tasks
- Generate sample Prometheus data
- Uploads migrate Rake tasks
- Uploads sanitize Rake tasks
- User management
- Webhooks administration
- X.509 signatures
- Server hooks
- Static objects external storage
- Updating GitLab
- GitLab release and maintenance policy
- Security
- Password Storage
- Custom password length limits
- Restrict allowed SSH key technologies and minimum length
- Rate limits
- Webhooks and insecure internal web services
- Information exclusivity
- How to reset your root password
- How to unlock a locked user from the command line
- User File Uploads
- How we manage the TLS protocol CRIME vulnerability
- User email confirmation at sign-up
- Security of running jobs
- Proxying assets
- CI/CD Environment Variables
- Contributor and Development Docs
- Contribute to GitLab
- Community members & roles
- Implement design & UI elements
- Issues workflow
- Merge requests workflow
- Code Review Guidelines
- Style guides
- GitLab Architecture Overview
- CI/CD development documentation
- Database guides
- Database Review Guidelines
- Database Review Guidelines
- Migration Style Guide
- What requires downtime?
- Understanding EXPLAIN plans
- Rake tasks for developers
- Mass inserting Rails models
- GitLab Documentation guidelines
- Documentation Style Guide
- Documentation structure and template
- Documentation process
- Documentation site architecture
- Global navigation
- GitLab Docs monthly release process
- Telemetry Guide
- Usage Ping Guide
- Snowplow Guide
- Experiment Guide
- Feature flags in development of GitLab
- Feature flags process
- Developing with feature flags
- Feature flag controls
- Document features deployed behind feature flags
- Frontend Development Guidelines
- Accessibility & Readability
- Ajax
- Architecture
- Axios
- Design Patterns
- Frontend Development Process
- DropLab
- Emojis
- Filter
- Frontend FAQ
- GraphQL
- Icons and SVG Illustrations
- InputSetter
- Performance
- Principles
- Security
- Tooling
- Vuex
- Vue
- Geo (development)
- Geo self-service framework (alpha)
- Gitaly developers guide
- GitLab development style guides
- API style guide
- Go standards and style guidelines
- GraphQL API style guide
- Guidelines for shell commands in the GitLab codebase
- HTML style guide
- JavaScript style guide
- Migration Style Guide
- Newlines style guide
- Python Development Guidelines
- SCSS style guide
- Shell scripting standards and style guidelines
- Sidekiq debugging
- Sidekiq Style Guide
- SQL Query Guidelines
- Vue.js style guide
- Instrumenting Ruby code
- Testing standards and style guidelines
- Flaky tests
- Frontend testing standards and style guidelines
- GitLab tests in the Continuous Integration (CI) context
- Review Apps
- Smoke Tests
- Testing best practices
- Testing levels
- Testing Rails migrations at GitLab
- Testing Rake tasks
- End-to-end Testing
- Beginner's guide to writing end-to-end tests
- End-to-end testing Best Practices
- Dynamic Element Validation
- Flows in GitLab QA
- Page objects in GitLab QA
- Resource class in GitLab QA
- Style guide for writing end-to-end tests
- Testing with feature flags
- Translate GitLab to your language
- Internationalization for GitLab
- Translating GitLab
- Proofread Translations
- Merging translations from CrowdIn
- Value Stream Analytics development guide
- GitLab subscription
- Activate GitLab EE with a license