Skip to content

Commit ad5c38e

Browse files
actions-useractions-user
committed
markdown source builds
Auto-generated via `{sandpaper}` Source : 7e63174 Branch : main Author : Dimitrios Theodorakis <[email protected]> Time : 2025-01-10 13:37:32 +0000 Message : MetOffice#45 Add in mermaid diagrams showing various workflows
1 parent e4bcf17 commit ad5c38e

File tree

5 files changed

+122
-9
lines changed

5 files changed

+122
-9
lines changed

‎02-branching.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ The next few episodes will guide you through examples of both models.
221221
This wasn't an exhaustive list of branching models!
222222
You can find more information using the links below:
223223

224-
- [From Novice to Pro: Understanding Git Branching Strategies, GitProtect](https://gitprotect.io/blog/from-novice-to-pro-understanding-git-branching-models/)
224+
- [From Novice to Pro: Understanding Git Branching Strategies, GitProtect](https://gitprotect.io/blog/from-novice-to-pro-understanding-git-branching-strategies/)
225225
- [What is a Git workflow?, GitLab](https://about.gitlab.com/topics/version-control/what-is-git-workflow/#forking-git-workflow)
226226

227227
:::::::::::::::::::::::::::::::::::::::: keypoints

‎04-review.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,32 @@ exercises: 10
2020

2121
In this section we will explore how to properly review
2222
code and suggest changes if necessary.
23+
Both science and code reviews happen in a Pull Request.
24+
The general process is outlined in the diagram below:
25+
26+
```mermaid
27+
sequenceDiagram
28+
accDescr {A sequence diagram showing the process of reviewing.}
29+
autonumber
30+
actor Developer
31+
actor Reviewer
32+
33+
Developer->>Reviewer: Request a reviewer
34+
Reviewer->>Reviewer: #32;
35+
Note over Reviewer: Add the reviewer<br/>to the pull request
36+
Reviewer->>Reviewer: #32;
37+
Note over Reviewer: Perform the review
38+
loop
39+
Reviewer->>Developer: Submit the review
40+
Developer->>Developer: #32;
41+
Note over Developer: Respond to each<br/>review comment
42+
Developer->>Reviewer: Re-request a review
43+
Reviewer->>Reviewer: #32;
44+
Note over Reviewer: Respond to each review<br/>comment response
45+
end
46+
Reviewer->>Developer: Approve the pull request
47+
```
48+
2349
Make sure you know who is in your pair.
2450
Find your colleagues open PR on the `git-training-demo`
2551
repository using the Pull Requests tab

‎05-forks.md‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -278,6 +278,60 @@ on your local `main` branch.
278278

279279
:::
280280

281+
## Summary Diagram
282+
283+
The workflow for forking is similar to that for branching.
284+
There are only a few differences after you've set up your fork
285+
for the first time:
286+
287+
- You should open Issues on the upstream repository not your fork.
288+
- After merging in a PR on the upstream repository you need the
289+
added step of syncing your forks `main` branch.
290+
291+
```mermaid
292+
sequenceDiagram
293+
accDescr {A sequence diagram showing the steps for using
294+
Forks with the branching model.}
295+
autonumber
296+
participant UM as upstream main
297+
participant GHM as origin main
298+
participant GHF as origin feature
299+
participant M as main
300+
UM ->> UM: #f
301+
Note over UM: Open an Issue for the change
302+
UM -->> GHM: #f
303+
Note right of UM: First time: Fork the repository
304+
GHM -->> M: #f
305+
Note right of GHM: First time: git clone<br/>Then: git pull
306+
create participant F as feature
307+
M ->> F: Create a feature branch:<br/>git switch -c feature
308+
loop
309+
F ->> F: #f
310+
Note over F: Develop changes:<br/>git add<br/>git commit
311+
end
312+
F -->> GHF: #f
313+
Note left of F: Push to GitHub: git push<br/>The first push creates origin feature!
314+
destroy GHF
315+
GHF -->> UM: #f
316+
Note left of GHF: Pull Request and then Merge.<br/>Delete origin feature branch.
317+
UM -->> GHM: #f
318+
Note right of UM: Sync your fork
319+
GHM -->> M: #f
320+
Note right of GHM: git pull
321+
Note over F: Delete branch:<br/>git branch -d feature
322+
box Upstream Remote - GitHub
323+
participant UM
324+
end
325+
box Fork Remote - GitHub
326+
participant GHM
327+
participant GHF
328+
end
329+
box Fork - Local
330+
participant M
331+
participant F
332+
end
333+
```
334+
281335
:::::::::::::::::::::::::::::::::::::::: keypoints
282336

283337
- A fork is a server side, in our case GitHub, copy

‎Break.md‎

Lines changed: 37 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,42 @@ You've now used the Feature Branch model to:
1111
3. Create a branch to develop your changes on
1212
4. Make changes to your working copy
1313
5. Open a Pull Request
14-
6. Review changes
15-
7. Respond to review
16-
8. Merge the Pull Request and close the Issue
17-
9. Tidy up your branches
14+
6. Respond to review
15+
7. Update your local copy and tidy up your branches
16+
17+
```mermaid
18+
sequenceDiagram
19+
accDescr {A sequence diagram showing the steps for the branching model.}
20+
autonumber
21+
participant GHM as origin main
22+
participant GHF as origin feature
23+
participant M as main
24+
GHM -->> GHM: #f
25+
Note over GHM: Open an Issue for the change
26+
GHM -->> M: #f
27+
Note right of GHM: First time: git clone<br/>Then: git pull
28+
create participant F as feature
29+
M ->> F: Create a feature branch:<br/>git switch -c feature
30+
loop
31+
F ->> F: #f
32+
Note over F: Develop changes:<br/>git add<br/>git commit
33+
end
34+
F -->> GHF: #f
35+
Note left of F: Push to GitHub: git push<br/>The first push creates origin feature!
36+
destroy GHF
37+
GHF ->> GHM: #f
38+
Note left of GHF: Pull Request and then Merge.<br/>Delete origin feature branch.
39+
GHM -->> M: #f
40+
Note right of GHM: git pull
41+
Note over F: Delete branch:<br/>git branch -D feature
42+
box GitHub Remote
43+
participant GHM
44+
participant GHF
45+
end
46+
box Local
47+
participant M
48+
participant F
49+
end
50+
```
1851

1952
Take a break - get up and move about.

‎md5sum.txt‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,11 @@
55
"index.md" "b0bde9e0a613102d1ae6f11c271ae32e" "site/built/index.md" "2025-01-09"
66
"episodes/00-repo-access.md" "69149f4f1439ae3798eab748291c5b33" "site/built/00-repo-access.md" "2025-01-09"
77
"episodes/01-issues.md" "a2cd906c1fd69b1be899f6e352334b0d" "site/built/01-issues.md" "2025-01-09"
8-
"episodes/02-branching.md" "67c14934ca1f8eced9b2c82159d54842" "site/built/02-branching.md" "2025-01-09"
8+
"episodes/02-branching.md" "16cffc6627b7b49d5cc96d02b6a388dc" "site/built/02-branching.md" "2025-01-10"
99
"episodes/03-feature-branch.md" "2aa2c1b8bd6bf77202e3dfecc69eca2d" "site/built/03-feature-branch.md" "2025-01-09"
10-
"episodes/04-review.md" "90bf3c25ead2368b8664603c6667a457" "site/built/04-review.md" "2025-01-09"
11-
"episodes/Break.md" "96f3c03ec9cd646c6366f840b7f21107" "site/built/Break.md" "2025-01-09"
12-
"episodes/05-forks.md" "47b583e34640bfbf92abb84c2c97540c" "site/built/05-forks.md" "2025-01-09"
10+
"episodes/04-review.md" "bc6707dc58f1ad84253b812726b54e09" "site/built/04-review.md" "2025-01-10"
11+
"episodes/Break.md" "3f756cfaee9cc1c397381668102aaea0" "site/built/Break.md" "2025-01-10"
12+
"episodes/05-forks.md" "b8def2a9442becd533880a3cebc319ad" "site/built/05-forks.md" "2025-01-10"
1313
"episodes/06-conflict.md" "168a9bc9aca94e053dcca42cfaef2953" "site/built/06-conflict.md" "2025-01-10"
1414
"episodes/07-history.md" "06de9dc87212934f2d7fc6ea7bbd97b2" "site/built/07-history.md" "2025-01-09"
1515
"episodes/End.md" "42f2019c55b38db5ec0eab909b6bca4d" "site/built/End.md" "2025-01-09"

0 commit comments

Comments
 (0)