diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-10-09 09:06:20 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-10-09 09:06:20 +0300 |
commit | 78adf0c5cc2534908e3f16a9b8abf06509444cf3 (patch) | |
tree | 668904a265a72a388f22e9543fd2204b4564b7ce /doc | |
parent | d1002a9e0dfd63273564b060e6ae62ccc0578200 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md | 9 | ||||
-rw-r--r-- | doc/ci/yaml/README.md | 72 |
2 files changed, 64 insertions, 17 deletions
diff --git a/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md b/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md index cbea1853e52..a3b346f2981 100644 --- a/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md +++ b/doc/administration/troubleshooting/gitlab_rails_cheat_sheet.md @@ -688,6 +688,15 @@ u = User.find_by_username('') MergeRequests::PostMergeService.new(p, u).execute(m) ``` +### Delete a merge request + +```ruby +u = User.find_by_username('<username>') +p = Project.find_by_full_path('<group>/<project>') +m = p.merge_requests.find_by(iid: <IID>) +Issuable::DestroyService.new(m.project, u).execute(m) +``` + ### Rebase manually ```ruby diff --git a/doc/ci/yaml/README.md b/doc/ci/yaml/README.md index 88f5fd2cdc2..aab26f361a4 100644 --- a/doc/ci/yaml/README.md +++ b/doc/ci/yaml/README.md @@ -627,8 +627,8 @@ docker build: - more_scripts/*.{rb,py,sh} ``` -In the scenario above, when pushing multiple commits to GitLab to an existing -branch, GitLab creates and triggers the `docker build` job, provided that one of the +In the scenario above, when pushing commits to an existing branch in GitLab, +it creates and triggers the `docker build` job, provided that one of the commits contains changes to any of the following: - The `Dockerfile` file. @@ -636,7 +636,13 @@ commits contains changes to any of the following: - Any of the files and subdirectories inside the `dockerfiles` directory. - Any of the files with `rb`, `py`, `sh` extensions inside the `more_scripts` directory. -You can also use glob patterns to match multiple files in either the root directory of the repo, or in _any_ directory within the repo. For example: +CAUTION: **Warning:** +If using `only:changes` with [only allow merge requests to be merged if the pipeline succeeds](../../user/project/merge_requests/merge_when_pipeline_succeeds.md#only-allow-merge-requests-to-be-merged-if-the-pipeline-succeeds), +undesired behavior could result if you do not [also use `only:merge_requests`](#using-onlychanges-with-pipelines-for-merge-requests). + +You can also use glob patterns to match multiple files in either the root directory +of the repo, or in _any_ directory within the repo, but they must be wrapped +in double quotes or GitLab will fail to parse the `.gitlab-ci.yml`. For example: ```yaml test: @@ -647,10 +653,8 @@ test: - "**/*.sql" ``` -NOTE: **Note:** -In the example above, the expressions are wrapped double quotes because they are glob patterns. GitLab will fail to parse `.gitlab-ci.yml` files with unwrapped glob patterns. - -The following example will skip the CI job if a change is detected in any file in the root directory of the repo with a `.md` extension: +The following example will skip the `build` job if a change is detected in any file +in the root directory of the repo with a `.md` extension: ```yaml build: @@ -661,22 +665,20 @@ build: ``` CAUTION: **Warning:** -There are some caveats when using this feature with new branches and tags. See -the section below. - -##### Using `changes` with new branches and tags - -When pushing a **new** branch or a **new** tag to GitLab, the policy always -evaluates to true and GitLab will create a job. This feature is not connected -with merge requests yet and, because GitLab is creating pipelines before a user -can create a merge request, it is unknown what the target branch is at this point. +There are some points to be aware of when +[using this feature with new branches or tags *without* pipelines for merge requests](using-onlychanges-without-pipelines-for-merge-requests). -##### Using `changes` with `merge_requests` +##### Using `only:changes` with pipelines for merge requests With [pipelines for merge requests](../merge_request_pipelines/index.md), it is possible to define a job to be created based on files modified in a merge request. +In order to deduce the correct base SHA of the source branch, we recommend combining +this keyword with `only: merge_requests`. This way, file differences are correctly +calculated from any further commits, thus all changes in the merge requests are properly +tested in pipelines. + For example: ```yaml @@ -694,6 +696,42 @@ In the scenario above, if a merge request is created or updated that changes either files in `service-one` directory or the `Dockerfile`, GitLab creates and triggers the `docker build service one` job. +Note that if [pipelines for merge requests](../merge_request_pipelines/index.md) is +combined with `only: change`, but `only: merge_requests` is omitted, there could be +unwanted behavior. + +For example: + +```yaml +docker build service one: + script: docker build -t my-service-one-image:$CI_COMMIT_REF_SLUG . + only: + changes: + - Dockerfile + - service-one/**/* +``` + +In the example above, a pipeline could fail due to changes to a file in `service-one/**/*`. +A later commit could then be pushed that does not include any changes to this file, +but includes changes to the `Dockerfile`, and this pipeline could pass because it is only +testing the changes to the `Dockerfile`. GitLab checks the **most recent pipeline**, +that **passed**, and will show the merge request as mergable, despite the earlier +failed pipeline caused by a change that was not yet corrected. + +With this configuration, care must be taken to check that the most recent pipeline +properly corrected any failures from previous pipelines. + +##### Using `only:changes` without pipelines for merge requests + +Without [pipelines for merge requests](../merge_request_pipelines/index.md), pipelines +run on branches or tags that don't have an explicit association with a merge request. +In this case, a previous SHA is used to calculate the diff, which equivalent to `git diff HEAD~`. +This could result in some unexpected behavior, including: + +- When pushing a new branch or a new tag to GitLab, the policy always evaluates to true. +- When pushing a new commit, the changed files are calculated using the previous commit + as the base SHA. + ### `rules` > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/29011) in GitLab 12.3. |