Browse Source

Add diagram for GAR

master
Wilfried OLLIVIER 2 months ago
parent
commit
4d2f6357c6
3 changed files with 32 additions and 9 deletions
  1. 10
    9
      README.md
  2. BIN
      diagrams/gar.png
  3. 22
    0
      diagrams/gar.src

+ 10
- 9
README.md View File

@@ -14,23 +14,23 @@ songs or album released by artists a Spotify user follows.
14 14
 Possible stack :
15 15
 
16 16
 - FrontEnd: VueJS
17
-    - print lists of albums to users
18
-    - trigger backend to sync data from Spotify to Redis
17
+  - print lists of albums to users
18
+  - trigger backend to sync data from Spotify to Redis
19 19
 - BackEnd: Golang
20
-    - Sync data using Spotify API to Redis cache
20
+  - Sync data using Spotify API to Redis cache
21 21
 - Redis
22
-    - Store data
22
+  - Store data
23 23
 
24 24
 ## Git Submodule Remover
25 25
 
26 26
 ### Description
27 27
 
28
-Git Submodule Remover (GSR) is a tool to used to remove submodule(s) from a 
28
+Git Submodule Remover (GSR) is a tool to used to remove submodule(s) from a
29 29
 git repo. Takes a path to a repo (`$PWD` if not specified) and a list of
30 30
 submodules (1..N), remove all the shit, prepare a default commit message and
31 31
 open `$EDITOR` to validate commit.
32 32
 
33
-### Possible interesting features 
33
+### Possible interesting features
34 34
 
35 35
 - An optional flag can trigger a push
36 36
 
@@ -42,16 +42,18 @@ open `$EDITOR` to validate commit.
42 42
 
43 43
 ### Description
44 44
 
45
-Create a service that listen to Gitlab event on a merge request. 
45
+Create a service that listen to Gitlab event on a merge request.
46 46
 Merging trigger API call to Gitlab to release a new version/tag.
47 47
 
48
+![GAR diagram](./diagrams/gar.png)
49
+
48 50
 #### Example
49 51
 
50 52
 Project `A` needs a security fix.
51 53
 
52 54
 Alice create a branch with a specific name like `fix-vuln`
53 55
 
54
-When it's ok, Alice create a merge request with name Fix: vuln or adds 
56
+When it's ok, Alice create a merge request with name Fix: vuln or adds
55 57
 labels like `secfix` to merge request.
56 58
 
57 59
 When merge is trigger, is CI build is green, send event to `auto-release` service
@@ -63,4 +65,3 @@ version number, new tag creation, etc...
63 65
 - Gitlab
64 66
 - Gitlab API
65 67
 - Golang service that listen to Gitlab Events
66
-

BIN
diagrams/gar.png View File


+ 22
- 0
diagrams/gar.src View File

@@ -0,0 +1,22 @@
1
+       +-----+ +---------+ +---------+
2
+       |     | |         | |         |
3
+       | Fix | | Release | | Feature |
4
+       |     | |         | |         |
5
+       +--+--+ +--+------+ +--+------+
6
+          |       |           |
7
+        +-*-------*-----------*-+
8
+        |                       |
9
+    +---+-* Gitlab Auto Release |<-+
10
+    |   |                       |  |
11
+    |   +-----------------------+  | (Commit ID, labels)
12
++---+--+                           |
13
+|      |                           | +----------------+
14
+| Tag  |                           | |                |
15
+|      |                           | | Merge Request  |
16
++--+---+                           | |                |
17
+   |                               | |                |
18
+   |   +------------------------+  | +----------------+
19
+   |   |                        |  |
20
+   +-->|        Gitlab     *----+--+
21
+       |                        |
22
+       +------------------------+

Loading…
Cancel
Save