2019-09-04 21:01:54 +05:30
|
|
|
---
|
|
|
|
type: reference, concepts
|
|
|
|
---
|
|
|
|
|
|
|
|
# "Work In Progress" merge requests
|
2016-09-29 09:46:39 +05:30
|
|
|
|
2019-07-07 11:18:12 +05:30
|
|
|
If a merge request is not yet ready to be merged, perhaps due to continued development
|
2019-09-30 21:07:59 +05:30
|
|
|
or open threads, you can prevent it from being accepted before it's ready by flagging
|
2019-07-07 11:18:12 +05:30
|
|
|
it as a **Work In Progress**. This will disable the "Merge" button, preventing it from
|
|
|
|
being merged, and it will stay disabled until the "WIP" flag has been removed.
|
2016-09-29 09:46:39 +05:30
|
|
|
|
|
|
|
![Blocked Accept Button](img/wip_blocked_accept_button.png)
|
|
|
|
|
2019-09-04 21:01:54 +05:30
|
|
|
## Adding the "Work In Progress" flag to a merge request
|
2019-07-07 11:18:12 +05:30
|
|
|
|
|
|
|
There are several ways to flag a merge request as a Work In Progress:
|
|
|
|
|
2019-09-30 21:07:59 +05:30
|
|
|
- Add `[WIP]` or `WIP:` to the start of the merge request's title. Clicking on
|
2019-07-07 11:18:12 +05:30
|
|
|
**Start the title with WIP:**, under the title box, when editing the merge request's
|
|
|
|
description will have the same effect.
|
2019-12-04 20:38:33 +05:30
|
|
|
- Add the `/wip` [quick action](../quick_actions.md#quick-actions-for-issues-merge-requests-and-epics)
|
2019-09-30 21:07:59 +05:30
|
|
|
in a comment in the merge request. This is a toggle, and can be repeated
|
2019-07-07 11:18:12 +05:30
|
|
|
to change the status back. Note that any other text in the comment will be discarded.
|
|
|
|
- Add "wip" or "WIP" to the start of a commit message targeting the merge request's
|
|
|
|
source branch. This is not a toggle, and doing it again in another commit will have
|
|
|
|
no effect.
|
|
|
|
|
2019-09-04 21:01:54 +05:30
|
|
|
## Removing the "Work In Progress" flag from a merge request
|
2019-07-07 11:18:12 +05:30
|
|
|
|
|
|
|
Similar to above, when a Merge Request is ready to be merged, you can remove the
|
|
|
|
"Work in Progress" flag in several ways:
|
|
|
|
|
2019-09-30 21:07:59 +05:30
|
|
|
- Remove `[WIP]` or `WIP:` from the start of the merge request's title. Clicking on
|
2019-07-07 11:18:12 +05:30
|
|
|
**Remove the WIP: prefix from the title**, under the title box, when editing the merge
|
|
|
|
request's description, will have the same effect.
|
2019-12-04 20:38:33 +05:30
|
|
|
- Add the `/wip` [quick action](../quick_actions.md#quick-actions-for-issues-merge-requests-and-epics)
|
2019-09-30 21:07:59 +05:30
|
|
|
in a comment in the merge request. This is a toggle, and can be repeated
|
2019-07-07 11:18:12 +05:30
|
|
|
to change the status back. Note that any other text in the comment will be discarded.
|
|
|
|
- Click on the **Resolve WIP status** button near the bottom of the merge request description,
|
|
|
|
next to the "Merge" button (see [image above](#work-in-progress-merge-requests)).
|
|
|
|
Must have at least Developer level permissions on the project for the button to
|
|
|
|
be visible.
|
|
|
|
|
2019-09-04 21:01:54 +05:30
|
|
|
## Including/excluding WIP merge requests when searching
|
2019-07-07 11:18:12 +05:30
|
|
|
|
|
|
|
When viewing/searching the merge requests list, you can choose to include or exclude
|
|
|
|
WIP merge requests by adding a "WIP" filter in the search box, and choosing "Yes"
|
|
|
|
(to include) or "No" (to exclude).
|
2018-12-05 23:21:45 +05:30
|
|
|
|
|
|
|
![Filter WIP MRs](img/filter_wip_merge_requests.png)
|
2019-09-04 21:01:54 +05:30
|
|
|
|
|
|
|
<!-- ## 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. -->
|