Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

gh-4 : convert ascii drawning to mermaid - both graph and gitgraph #5

Merged
merged 4 commits into from
Apr 26, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 29 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,36 @@ A few remarks, aspects and thoughts when retrieving the artifacts
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.

The history is basically like this

``` mermaid
%%{init: { 'gitGraph': {'showCommitLabel': false, 'showBranches': true}} }%%
gitGraph
commit id: "init" tag: "init"
branch latest-1.0
branch latest-1.1
branch latest-1.2
branch latest-2.0
branch latest
checkout latest-1.0
commit id: "1.0/bin" tag: "1.0/bin"
commit id: "1.0/src" tag: "1.0/src"
checkout latest-1.1
commit id: "1.1/bin" tag: "1.1"
checkout latest-1.2
commit id: "1.2/bin" tag: "1.2"
checkout latest-2.0
commit id: "2.0/bin" tag: "2.0"
checkout latest-1.0
commit id: "2.0/test" tag: "2.0/test"
```

``` mermaid
graph TD;
0.1/bin --> main;
0.2/test --> 0.2/src --> 0.2/bin --> main;
0.3/bin --> main;
```
[0.2/test]
|
[0.1/bin] [0.2/bin] [0.3/bin]
| / /
<main>
```

`git-artifacts` has all the functions available that make the above history straight for and natural workflow.

### Prerequisites
Expand Down
Loading