gitlab-org--gitlab-foss/doc/user/project/merge_requests/allow_collaboration.md

4.5 KiB

stage group info type
Create Code Review 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 reference, howto

Allow collaboration on merge requests across forks (FREE)

Introduced in GitLab 10.6.

When a user opens a merge request from a fork, they are given the option to allow upstream members to collaborate with them on the source branch. This allows the members of the upstream project to make small fixes or rebase branches before merging, reducing the back and forth of accepting external contributions.

This feature is available for merge requests across forked projects that are publicly accessible.

When enabled for a merge request, members with merge access to the target branch of the project is granted write permissions to the source branch of the merge request.

Enabling commit edits from upstream members

In GitLab 13.7 and later, this setting is enabled by default. It can be changed by users with the Developer role for the source project. After it's enabled, upstream members can retry the pipelines and jobs of the merge request:

  1. While creating or editing a merge request, scroll to Contribution and then select the Allow commits from members who can merge to the target branch. checkbox.
  2. Finish creating your merge request.

After you create the merge request, the merge request widget displays a message: Members who can merge are allowed to add commits.

Pushing to the fork as the upstream member

If the creator of the merge request has enabled contributions from upstream members, you can push directly to the branch of the forked repository.

Assuming that:

  • The forked project URL is git@gitlab.com:thedude/awesome-project.git.
  • The branch of the merge request is update-docs.

To find and work with the changes from the fork:

  1. Open the merge request page, and select the Overview tab.

  2. Scroll to the merge request widget, and select Check out branch: Check out branch button

  3. In the modal window, select {copy-to-clipboard} (Copy) for step 1 to copy the git fetch and git checkout instructions to your clipboard. Paste the commands (which look like this example) into your terminal:

    git fetch git@gitlab.com:thedude/awesome-project.git update-docs
    git checkout -b thedude-awesome-project-update-docs FETCH_HEAD
    

    These commands fetch the branch from the forked project, and create a local branch based off the fetched branch.

  4. Make your changes to the local copy of the branch, and then commit them.

  5. In your terminal, push your local changes back up to the forked project. This command pushes the local branch thedude-awesome-project-update-docs to the update-docs branch of the git@gitlab.com:thedude/awesome-project.git repository:

    git push git@gitlab.com:thedude/awesome-project.git thedude-awesome-project-update-docs:update-docs
    

    Note the colon (:) between the two branches.

Troubleshooting

Pipeline status unavailable from MR page of forked project

When a user forks a project, the permissions of the forked copy are not copied from the original project. The creator of the fork must grant permissions to the forked copy before members in the upstream project can view or merge the changes in the merge request.

To see the pipeline status from the merge request page of a forked project going back to the original project:

  1. Create a group containing all the upstream members.
  2. Go to the Project information > Members page in the forked project and invite the newly-created group to the forked project.