Skip to content

Commit 21a32ce

Browse files
authored
Merge pull request #5 from Praqma/gh-4-mermaid
gh-4 : convert ascii drawning to mermaid - both graph and gitgraph
2 parents 7c6deea + 615de3c commit 21a32ce

File tree

1 file changed

+36
-9
lines changed

1 file changed

+36
-9
lines changed

README.md

+36-9
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
I have, over the years in the embbeded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspace
55
has slowed down turn around time for developers and CI system. Git is a fantastic zipper it self and you get integrity of workspaces for free.
66

7-
Git has always been mentioned to be bad for storing artifacts due to the block chain technology and distrubuted architecture. Git-artifact make sure this problem is handled by storing commits "horisontally" using tags rather than the default "stacked" way. It gives a few advantages compared to standard usage of git:
7+
Git has always been mentioned to be bad for storing artifacts due to the block chain technology and distrubuted architecture. `git-artifact` make sure this problem is handled by storing commits "horisontally" using tags rather than the default "stacked" way. It gives a few advantages compared to standard usage of git:
88
- Firstly; You can garbage collect intermidiate artifacts by just deleting the tag
99
- Secondly; You only fetch what you need - even without using shallow.
1010

@@ -33,14 +33,41 @@ A few remarks, aspects and thoughts when retrieving the artifacts
3333
Git normally stacks the history hence you cannot delete commit in the middle of the history. `git-artifact` make a "horizontal" history - i.e the commits are not stacked on top of each other, but next to each other.
3434

3535
The history is basically like this
36-
```
37-
[0.2/test]
38-
|
39-
[0.1/bin] [0.2/bin] [0.3/bin]
40-
| / /
41-
<main>
42-
```
43-
`git-artifacts` has all the functions available that make the above history straight for and natural workflow.
36+
37+
``` mermaid
38+
%%{init: {
39+
'gitGraph': {
40+
'loglevel' : 'debug',
41+
'orientation': 'vertical',
42+
'showCommitLabel': true,
43+
'showBranches': false
44+
}} }%%
45+
gitGraph:
46+
commit id: "init" tag: "init" type: HIGHLIGHT
47+
branch latest-1.0 order: 2
48+
branch latest-1.1 order: 3
49+
branch latest-1.2 order: 4
50+
branch latest-2.0 order: 5
51+
checkout latest-1.0
52+
commit id: "1.0/bin" tag: "1.0/bin"
53+
commit id: "1.0/src" tag: "1.0/src"
54+
checkout latest-1.1
55+
commit id: "1.1/bin" tag: "1.1"
56+
checkout latest-1.2
57+
commit id: "1.2/bin" tag: "1.2"
58+
checkout latest-2.0
59+
commit id: "2.0/bin" tag: "2.0"
60+
checkout main
61+
commit id: "update scripts" tag: "main" type: HIGHLIGHT
62+
branch foo order: 1
63+
checkout foo
64+
commit id: "3.0/bin" tag: "3.0/bin"
65+
checkout latest-1.0
66+
commit id: "2.0/test" tag: "2.0/test"
67+
```
68+
69+
70+
`git-artifact` has all the functions available that make the above history natural workflow.
4471

4572
### Prerequisites
4673
The tool uses tags hence the producer need to tag push-rights. It is also beneficial to have tag delete-rights to clean old artifacts.

0 commit comments

Comments
 (0)