diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-12-01 15:16:08 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-12-01 15:16:08 +0300 |
commit | c9439a09c51acff525f2e5c5cba8caecc270da8b (patch) | |
tree | cd344f3ce05525dccbc5f7d607d3fd1e76b46cd2 /doc | |
parent | 7bc1ee0bcb9cefaf788aa0b93383b7347e9010b0 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/development/contributing/style_guides.md | 15 | ||||
-rw-r--r-- | doc/development/testing_guide/review_apps.md | 6 | ||||
-rw-r--r-- | doc/user/project/merge_requests/creating_merge_requests.md | 2 |
3 files changed, 17 insertions, 6 deletions
diff --git a/doc/development/contributing/style_guides.md b/doc/development/contributing/style_guides.md index 754e6c7aec6..e3b8f7372b9 100644 --- a/doc/development/contributing/style_guides.md +++ b/doc/development/contributing/style_guides.md @@ -171,7 +171,10 @@ we should track our progress through the exception list. When auto-generating the `.rubocop_todo.yml` exception list for a particular Cop, and more than 15 files are affected, we should add the exception list to -a different file, `.rubocop_manual_todo.yml`. +a different file within `.rubocop_todo/` directory. + +For example, the configuration for the cop `Gitlab/NamespacedClass` is located +in `.rubocop_todo/gitlab/namespaced_class.yml`. This ensures that our list isn't mistakenly removed by another auto generation of the `.rubocop_todo.yml`. This also allows us greater visibility into the exceptions @@ -184,19 +187,19 @@ bundle exec rake rubocop:todo:generate ``` You can then move the list from the freshly generated `.rubocop_todo.yml` for the Cop being actively -resolved and place it in the `.rubocop_manual_todo.yml`. In this scenario, do not commit auto generated -changes to the `.rubocop_todo.yml` as an `exclude limit` that is higher than 15 will make the -`.rubocop_todo.yml` hard to parse. +resolved and place it in the directory `.rubocop_todo/`. In this scenario, do not commit +auto-generated changes to the `.rubocop_todo.yml`, as an `exclude limit` that is higher than 15 +makes the `.rubocop_todo.yml` hard to parse. ### Reveal existing RuboCop exceptions To reveal existing RuboCop exceptions in the code that have been excluded via `.rubocop_todo.yml` and -`.rubocop_manual_todo.yml`, set the environment variable `REVEAL_RUBOCOP_TODO` to `1`. +`.rubocop_todo/**/*.yml`, set the environment variable `REVEAL_RUBOCOP_TODO` to `1`. This allows you to reveal existing RuboCop exceptions during your daily work cycle and fix them along the way. NOTE: -Permanent `Exclude`s should be defined in `.rubocop.yml` instead of `.rubocop_manual_todo.yml`. +Define permanent `Exclude`s in `.rubocop.yml` instead of `.rubocop_todo/**/*.yml`. ## Database migrations diff --git a/doc/development/testing_guide/review_apps.md b/doc/development/testing_guide/review_apps.md index 2c536c441e4..cfdb3ad0d62 100644 --- a/doc/development/testing_guide/review_apps.md +++ b/doc/development/testing_guide/review_apps.md @@ -36,6 +36,12 @@ On every [pipeline](https://gitlab.com/gitlab-org/gitlab/pipelines/125315730) in browser performance testing using a [Sitespeed.io Container](../../user/project/merge_requests/browser_performance_testing.md). +## Sample Data for Review Apps + +Upon deployment of a review app, project data is created from the [`sample-gitlab-project`](https://gitlab.com/gitlab-org/sample-data-templates/sample-gitlab-project) template project. This aims to provide projects with prepopulated resources to facilitate manual and exploratory testing. + +The sample projects will be created in the `root` user namespace and can be accessed from the personal projects list for that user. + ## How to ### Redeploy Review App from a clean slate diff --git a/doc/user/project/merge_requests/creating_merge_requests.md b/doc/user/project/merge_requests/creating_merge_requests.md index e15874d2df8..220049d9a88 100644 --- a/doc/user/project/merge_requests/creating_merge_requests.md +++ b/doc/user/project/merge_requests/creating_merge_requests.md @@ -159,6 +159,8 @@ branch already exists, the patches are applied on top of it. ## Set the default target project +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/58093) in GitLab 13.11. + Merge requests have a source and a target project that are the same, unless forking is involved. Creating a fork of the project can cause either of these scenarios when you create a new merge request: |