GitLab pull request configurations
Summarize
Summary of GitLab Pull Request Configurations
GitLab pull (merge) request configurations facilitate tracking and managing pipeline executions for change acceleration before production deployment. This integration with DevOps Change Velocity collects metadata from merge requests, linking it with change creation for policy application, review, and approval processes.
Show less
Key Features
- Support for creating, updating, closing, re-opening, and merging pull requests.
- Automatic updates of the GitLab pipeline status according to the pull request status.
- Maximum of 100 commits displayed in DevOps Change Velocity, with access to more requiring reference to the GitLab instance.
- Only the latest comment is retained within the DevOps Change Velocity.
- Automatic pausing and resuming of pipelines during pull request executions.
Key Outcomes
To enable tracking of GitLab pull requests in DevOps Change Velocity:
- By default, the tracking property is enabled. Disable it if you do not wish to track pull requests.
- Utilize GitLab Docker for change tracking.
- Ensure the "Pipelines must succeed" option is checked, blocking merges until changes are approved.
- Incorporate specific rules in your .yml file to manage pipeline behavior based on merge request events.
GitLab pull (merge) request pipeline executions, which goes through change acceleration before moving to production, can be tracked in DevOps Change Velocity. This integration also collects GitLab merge requests meta data to persist in DevOps Change Velocity. The data is linked with the change created in the merge request pipeline execution and can be used for applying change policies, review, and approval.
- Create, update, close, re-open, and merge of pull requests are supported.
- Pull request pipeline execution for change acceleration in GitLab pipelines is supported. Pull request details will be available for use in the change approval policy.
- Status of GitLab pipeline is updated with the pull request status automatically after the change creation. The pipeline is paused and resumed automatically.
- Email ids are defaulted to the format <user_name>@noreply.gitlab.com.
- Comments are supported as part of merge request support. Create and update to pull requests are supported, while delete and edit are not supported.
- Maximum of 100 commits will be shown in DevOps Change Velocity. If you need to access more than 100, you must refer your GitLab instance. Only the latest comment is populated.
Settings to enable pull (merge) requests for change approval
When enabled, the pull (merge) request changes will be reflected in DevOps Change Velocity. When disabled, DevOps Change Velocity ignores the pull request events.
- Use GitLab Docker for change tracking. For detailed information, see Implement custom actions for pipelines using a generic Docker container image.
- From your GitLab project,
- Navigate to
- For GitLab cloud: .
- For On premises (13.x): .
- Select the Pipelines must succeed check box.
With this selection, only if the change is approved, you can proceed with the merge request. That is, when the check box is selected, pull requests will be blocked until the change is approved.
- Select Save changes.
- Navigate to
- Navigate to your project and open the .yml file.To the .yml file, add the following rule at the pipeline level or at specific job levels.
rules: - if: $CI_PIPELINE_SOURCE == 'merge_request event' - if: $CI_PIPELINE_SOURCE != 'merge_request_event'Example for pipeline level:
workflow: rules: - if: $CI_PIPELINE_SOURCE == 'merge_request_event' - if: $CI_PIPELINE_SOURCE != 'merge_request_event'Example for job level:
changeapproval: stage: changeapproval script: - sndevopscli create change -p '{"changeStepDetails":{"timeout":3600,"interval":100},"attributes":{"short_description":"Automated Software Deployment","description":"Automated Software Deployment.","assignment_group":"a715cd759f2002002920bde8132e7018","implementation_plan":"Software update is tested and results can be found in Test Summaries Tab.","backout_plan":"When software fails in production, the previous software release will be re-deployed.","test_plan":"Testing if the software was successfully deployed or not"}}' rules: - if: $CI_PIPELINE_SOURCE == 'merge_request_event' - if: $CI_PIPELINE_SOURCE != 'merge_request_event'