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
docs: add fan-out fan-in section to workflows page (#573)
## 📝 Description
- Add Fan-Out, Fan-In section back from the old docs to the current docs
- Add a Job Matrix video to the job pages
See #572 for more information
Note: waiting for YouTube video to be published
## ✅ Checklist
- [X] I have tested this change
- [ ] This change requires documentation update
Copy file name to clipboardExpand all lines: docs/docs/using-semaphore/jobs.md
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1089,6 +1089,8 @@ It's not possible to use job parallelism at the same time as [job matrices](#mat
1089
1089
1090
1090
## Job matrix {#matrix}
1091
1091
1092
+
<VideoTutorial title="How to use a Job Matrix" src="https://www.youtube.com/embed/jRpj2Pu5eak" />
1093
+
1092
1094
A job matrix is a more advanced form of [job parallelism](#job-parallelism) where you can define multiple variables with different values and run all the possible permutations.
1093
1095
1094
1096
For example, let's say we want to test our application using three Node.js versions using npm and yarn
Copy file name to clipboardExpand all lines: docs/docs/using-semaphore/workflows.md
+133-5Lines changed: 133 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -27,30 +27,159 @@ Before you can run a workflow in Semaphore you need:
27
27
- A Semaphore project linked to the repository
28
28
- One or more pipelines
29
29
30
-
The [project page](./projects#view-projects) shows all the recent workflows for the project.
30
+
The [project page](./projects#view-projects) shows all the recent workflows for the project.
31
31
32
32

33
33
34
34
## Visual workflow editor {#workflow-editor}
35
35
36
36
<VideoTutorialtitle="How to use the workflow builder"src="https://www.youtube.com/embed/dg2jDQmYJ_4" />
37
37
38
-
You can define most aspects of your workflows using the visual editor.
38
+
You can define most aspects of your workflows using the visual editor.
39
39
40
40
To access the editor, open one of your projects on and press **Edit Workflow**. All your changes are stored as YAML pipeline definitions on your Git repository. You can make changes using the visual editor, or edit the YAML directly by clicking on the pipeline YAML file.
This section provides guides to model complex, non-linear CI/CD processes.
49
+
50
+
### Fan-out Fan-In {#fan-out-fan-in}
51
+
52
+
<VideoTutorialtitle="Fan Out - Fan In"src="https://www.youtube.com/embed/HKv-jMkC7T0" />
53
+
54
+
The Fan-Out Fan-In workflow provides consistency and maximum parallelization. It can be split into 3 stages:
55
+
56
+
1.**Build stage**: you build your project once
57
+
2.**Fan-Out stage**: all your tests fan out from the build stage and run in parallel
58
+
3.**Fan-In stage**: once tested, the workflow fans in to a release or deploy stage
59
+
60
+

61
+
62
+
<TabsgroupId="editor-yaml">
63
+
<TabItemvalue="editor"label="Editor"default>
64
+
65
+
<Steps>
66
+
67
+
1. Create your build [job](./jobs). Depending on the nature of your project, you can save the built artifact to the [artifact store](./artifacts) or push it to a [Docker registry](./containers/docker)
68
+
69
+

70
+
71
+
2. Add your test jobs. Set dependencies so all your tests depend on the build job created on Step 1
72
+
73
+

74
+
75
+
3. Add the release/deploy job. Use dependencies so the new job depends on all your tests. This will make the release/job run only if all tests have passed
76
+
77
+

78
+
79
+
</Steps>
80
+
81
+
</TabItem>
82
+
<TabItemvalue="yaml"label="YAML">
83
+
84
+
You can create a Fan-Out Fan-In workflow by setting the dependencies in your blocks. The Fan-Out stage is achieved by defining `dependencies`. For example:
0 commit comments