admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-13 14:55:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

fixes

Browse source
This commit is contained in:
Julie Kirsch 2024-11-05 19:31:07 +01:00
parent 93090ee2d6
commit a5159e0280
2 changed files with 10 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
book/workflows/figures/Merge_Request_GitLab.PNG Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 49 KiB

20
book/workflows/merge_request.md
View file

@ -1,4 +1,4 @@
# Reviewing and combine versions (merge / pull request, merging)
# Reviewing and combine versions (merge/pull request, merging)
Merging a branch into the main branch is also good moment to let a team-member review the content. By assigning a colleague to review your branch you can check the quality of your new content.
@ -18,7 +18,7 @@ We're finished with our chapter, and now it's time to include all of our commits
3. You can now choose a source branch and a target branch. Since we want to merge our changes from `chapter-2` *into* `main`, `chapter-2` is the source branch and `main` is the target branch ({numref}`gitlab-merge-request`) . Once you've selected the correct branches, click "Compare branches and continue".
```{figure} ../images/gitlab-merge-request.png
:name: gitlab-merge-request
name: gitlab-merge-request
Creating a new merge request to merge `chapter-2` into `main`.
```
@ -26,22 +26,22 @@ Creating a new merge request to merge `chapter-2` into `main`.
4. On the next page, you can give your merge request a name, and provide a description of your changes ({numref}`gitlab-merge-request-description`). If somebody has to review your changes, you can add them in the "Reviewer menu". They will then be notified via email that they need to review your work. Finally, watch out for the option "Delete source branch when merge request is accepted". If you want to keep working on the same branch, even after your previous work has been merged, make sure you untick the box! Once everything is filled in, click "Create merge request".
```{figure} ../images/gitlab-merge-request-description.png
:name: gitlab-merge-request-description
name: gitlab-merge-request-description
Example of a filled-in merge request.
```
5. After clicking `create merge request` you should land on the following page. Here, you can track the merge request. Right after your request, GitLab will do some checks to see if you've tried to merge conflicting files. As you can see in the figure below the merge is blocked due to the conflicts. Click on 'Resolve conflicts`.
```{figure} ../figures/Merge_Request_GitLab.PNG
:name: gitlab-merge-request-conflict
```{figure} figures/Merge_Request_GitLab.PNG
name: gitlab-merge-request-conflict
Example of a blocked merge.
```
Clicking on 'Resolve conflicts`, will open the conflicted files in the text editor. There you can manually edit the files to the version you would like to retain. By clicking on `use ours` or `use theirs` you can select which version you would like to keep.
Clicking on `Resolve conflicts`, will open the conflicted files in the text editor. There you can manually edit the files to the version you would like to retain. Alternatively, by clicking on `use ours` or `use theirs` you can select which version you would like to keep.
```{figure} ../figures/Solve_Conflict.PNG
:name: gitlab-conflict
```{figure} figures/Solve_Conflict.PNG
name: gitlab-conflict
Solving the conflict.
```
@ -51,8 +51,8 @@ In case you have cloned the repositery you can also resolve the conflicts locall
6. On the page of our merge request ({numref}`gitlab-finished-merge-request`), we're greeted with some more information. On top, you can read the description we just provided when creating the merge request. We can also see an "Approve" button, which you may or may not see, depending on your repository rights. Next, we can see a green checkmark, with a "Merge" button. This is good news: our changes do not conflict with existing files on the `main` branch, and we can merge our changes directly by clicking the button (if applicable: only after somebody else approved the request).
```{figure} ../../images/gitlab-finished-merge-request.png
:name: gitlab-finished-merge-request
```{figure} ../images/gitlab-finished-merge-request.png
name: gitlab-finished-merge-request
The finished merge request.
```