You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/18-workflows.md
+24-7Lines changed: 24 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
The video by Nick Chapsas "Getting started with branching workflows, Git Flow and GitHub Flow" provides a summary of these two workflows.
4
4
5
-
[Getting started with branching workflows, Git Flow and GitHub Flow (youtube.com)](https://www.youtube.com/watch?v=gW6dFpTMk8s)
5
+
<iframewidth="560"height="315"src="https://www.youtube.com/embed/gW6dFpTMk8s?si=H6Hhn5CDRE5BLNSD"title="YouTube video player"frameborder="0"allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"allowfullscreen></iframe>
6
6
7
7
## Git Flow Workflow
8
8
@@ -14,14 +14,18 @@ Here's how it works:
14
14
15
15
1.**Main Branches**: There are two main branches:
16
16
-`main`(or `master`): This is the branch that contains the production-ready code.
17
+
17
18
-`develop`: This is the branch where all the new features and bug fixes are integrated before being merged into
18
19
the`main`branch.
20
+
19
21
2.**Supporting Branches**: There are also supporting branches for specific tasks:
20
22
-`feature`branches: These branches are used to develop new features. When a feature is complete, it is merged back
21
23
into the`develop`branch.
24
+
22
25
-`release`branches: When the`develop`branch is stable and ready for a release, a`release`branch is created from it.
23
26
This is where any last-minute bug fixes or documentation updates are made before the release is merged into
24
27
the`main`branch and tagged with a version number.
28
+
25
29
-`hotfix`branches: These branches are used to quickly fix critical issues in the production code (`master`branch).
26
30
When the fix is complete, it is merged back into both the`main`and`develop`branches.
27
31
@@ -36,24 +40,33 @@ It's designed to work well with GitHub's features and allows for more frequent d
36
40
Here's how it works:
37
41
38
42
1.**Main Branch**: There is only one main branch, typically called`main`or `master`.
43
+
39
44
2.**Feature Branches**: Whenever you want to work on a new feature or bug fix, you create a new branch from the `main`
40
45
branch.
46
+
41
47
3.**Pull Requests**: When you're ready to merge your changes back into the `main` branch, you create a Pull Request. This
42
48
allows others to review your code and provide feedback before merging.
49
+
43
50
4.**Code Reviews**: The Pull Request triggers a code review process, where team members can discuss the changes,
44
51
suggest improvements, or request additional changes.
52
+
45
53
5.**Merge and Deploy**: Once the code has been reviewed and approved, the feature branch is merged into the `main`
46
54
branch. This merged code can then be deployed to production.
47
55
48
56
GitHub Flow encourages frequent, small updates to the codebase, making it easier to manage and integrate changes.
49
57
50
-
## Further Reading and Tutorials
51
58
52
-
Select one or two to review and make notes about.
59
+
# References
53
60
54
-
Feel free to feedback as to what you think about the selected items.
61
+
The references show details of any articles, videos and other items that were used in this chapter, plus other, possibly useful items.
62
+
63
+
Chapsas, N. (2021). _Getting started with branching workflows, Git Flow and GitHub Flow_. [online]www.youtube.com. Available at: https://www.youtube.com/watch?v=gW6dFpTMk8s[Accessed 15 Mar. 2024].
64
+
65
+
Git Dailies (n.d.). _Guide to Git Flow_. [online] GitDailies: Software Engineering Metrics Made Easy. Available at: https://gitdailies.com/articles/git-flow-guide/[Accessed 15 Mar. 2024].
66
+
67
+
68
+
Other links
55
69
56
-
-[Guide to Git Flow (gitdailies.com)](https://gitdailies.com/articles/git-flow-guide/)
0 commit comments