93 lines
4.6 KiB
Markdown
93 lines
4.6 KiB
Markdown
---
|
|
stage: Create
|
|
group: Code Review
|
|
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
|
|
type: reference, concepts
|
|
disqus_identifier: 'https://docs.gitlab.com/ee/user/project/merge_requests/work_in_progress_merge_requests.html'
|
|
---
|
|
|
|
# Draft merge requests **(FREE)**
|
|
|
|
If a merge request isn't ready to merge, potentially because of continued development
|
|
or open threads, you can prevent it from being accepted before you
|
|
[mark it as ready](#mark-merge-requests-as-ready). Flag it as a draft to disable
|
|
the **Merge** button until you remove the **Draft** flag:
|
|
|
|
|
|
|
|
## Mark merge requests as drafts
|
|
|
|
> - [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/32692) in GitLab 13.2, Work-In-Progress (WIP) merge requests were renamed to **Draft**.
|
|
> - [Removed](https://gitlab.com/gitlab-org/gitlab/-/issues/228685) all support for using **WIP** in GitLab 14.8.
|
|
> - **Mark as draft** and **Mark as ready** buttons [introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/227421) in GitLab 13.5.
|
|
|
|
There are several ways to flag a merge request as a draft:
|
|
|
|
- **Viewing a merge request**: In the top right corner of the merge request, select **Mark as draft**.
|
|
- **Creating or editing a merge request**: Add `[Draft]`, `Draft:` or `(Draft)` to
|
|
the beginning of the merge request's title, or select **Start the title with Draft:**
|
|
below the **Title** field.
|
|
- **Commenting in an existing merge request**: Add the `/draft`
|
|
[quick action](../quick_actions.md#issues-merge-requests-and-epics)
|
|
in a comment. This quick action is a toggle, and can be repeated to change the status
|
|
back to Ready.
|
|
- **Creating a commit**: Add `draft:`, `Draft:`, `fixup!`, or `Fixup!` to the
|
|
beginning of a commit message targeting the merge request's source branch. This
|
|
is not a toggle, and adding this text again in a later commit doesn't mark the
|
|
merge request as ready.
|
|
|
|
## Mark merge requests as ready
|
|
|
|
When a merge request is ready to be merged, you can remove the `Draft` flag in several ways:
|
|
|
|
- **Viewing a merge request**: In the top right corner of the merge request, select **Mark as ready**.
|
|
Users with at least the Developer role
|
|
can also scroll to the bottom of the merge request description and select **Mark as ready**:
|
|
|
|
|
|
|
|
- **Editing an existing merge request**: Remove `[Draft]`, `Draft:` or `(Draft)`
|
|
from the beginning of the title, or select **Remove the Draft: prefix from the title**
|
|
below the **Title** field.
|
|
- **Commenting in an existing merge request**: Add the `/ready`
|
|
[quick action](../quick_actions.md#issues-merge-requests-and-epics)
|
|
in a comment in the merge request.
|
|
|
|
In [GitLab 13.10 and later](https://gitlab.com/gitlab-org/gitlab/-/issues/15332),
|
|
when you mark a merge request as ready, notifications are triggered to
|
|
[merge request participants and watchers](../../profile/notifications.md#notifications-on-issues-merge-requests-and-epics).
|
|
|
|
## Include or exclude drafts when searching
|
|
|
|
When viewing or searching in your project's merge requests list, you can include or exclude
|
|
draft merge requests:
|
|
|
|
1. Go to your project and select **Merge requests**.
|
|
1. In the navigation bar, select **Open**, **Merged**, **Closed**, or **All** to
|
|
filter by merge request status.
|
|
1. Select the search box to display a list of filters and select **Draft**, or
|
|
enter the word `draft`.
|
|
1. Select `=`.
|
|
1. Select **Yes** to include drafts, or **No** to exclude, and press **Return**
|
|
to update the list of merge requests:
|
|
|
|
|
|
|
|
## Pipelines for drafts
|
|
|
|
Draft merge requests run the same pipelines as merge request that are marked as ready.
|
|
|
|
In GitLab 15.0 and older, you must [mark the merge request as ready](#mark-merge-requests-as-ready)
|
|
if you want to run [merged results pipelines](../../../ci/pipelines/merged_results_pipelines.md).
|
|
|
|
<!-- ## Troubleshooting
|
|
|
|
Include any troubleshooting steps that you can foresee. If you know beforehand what issues
|
|
one might have when setting this up, or when something is changed, or on upgrading, it's
|
|
important to describe those, too. Think of things that may go wrong and include them here.
|
|
This is important to minimize requests for support, and to avoid doc comments with
|
|
questions that you know someone might ask.
|
|
|
|
Each scenario can be a third-level heading, e.g. `### Getting error message X`.
|
|
If you have none to add when creating a doc, leave this section in place
|
|
but commented out to help encourage others to add to it in the future. -->
|