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.

Sign up for GitHub

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

Jump to bottom

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

Merged
merged 4 commits into from
Apr 26, 2024
Merged

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

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
44c1980
gh-4 : convert ascii drawning to mermaid - both graph and gitgraph
bicschneider Apr 26, 2024
208b9b1
gh-4 : convert ascii drawning to mermaid - both graph and gitgraph - fix
bicschneider Apr 26, 2024
39075a5
gh-4 : convert ascii drawning to mermaid - both graph and gitgraph - fix
bicschneider Apr 26, 2024
615de3c
gh-4 : convert ascii drawning to mermaid - both graph and gitgraph
bicschneider Apr 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
45 changes: 36 additions & 9 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
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
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the spelling of "embbeded" to "embedded".

- 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
+ I have, over the years in the embedded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspace
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
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
I have, over the years in the embedded enterprise industry, constantly come across many scenarios where zipping, downloading and unzipping generic dependencies and maintaining workspace

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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the phrase "it self" to "itself".

- Git is a fantastic zipper it self and you get integrity of workspaces for free.
+ Git is a fantastic zipper itself and you get integrity of workspaces for free.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
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.
has slowed down turn around time for developers and CI system. Git is a fantastic zipper itself and you get integrity of workspaces for free.


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:
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:
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the spelling of "block chain" to "blockchain", "distrubuted" to "distributed", and "horisontally" to "horizontally".

- 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.
+ Git has always been mentioned to be bad for storing artifacts due to the blockchain technology and distributed architecture. `git-artifact` make sure this problem is handled by storing commits "horizontally" using tags rather than the default "stacked" way.
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
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:
Git has always been mentioned to be bad for storing artifacts due to the blockchain technology and distributed architecture. `git-artifact` make sure this problem is handled by storing commits "horizontally" using tags rather than the default "stacked" way. It gives a few advantages compared to standard usage of git:

- Firstly; You can garbage collect intermidiate artifacts by just deleting the tag
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Correct the spelling of "intermidiate" to "intermediate".

- Firstly; You can garbage collect intermidiate artifacts by just deleting the tag
+ Firstly; You can garbage collect intermediate artifacts by just deleting the tag
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
- Firstly; You can garbage collect intermidiate artifacts by just deleting the tag
Firstly; You can garbage collect intermediate artifacts by just deleting the tag

- Secondly; You only fetch what you need - even without using shallow.

Expand Down Expand Up @@ -33,14 +33,41 @@ 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
```
[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.

``` mermaid
%%{init: {
'gitGraph': {
'loglevel' : 'debug',
'orientation': 'vertical',
'showCommitLabel': true,
'showBranches': false
}} }%%
gitGraph:
commit id: "init" tag: "init" type: HIGHLIGHT
branch latest-1.0 order: 2
branch latest-1.1 order: 3
branch latest-1.2 order: 4
branch latest-2.0 order: 5
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 main
commit id: "update scripts" tag: "main" type: HIGHLIGHT
branch foo order: 1
checkout foo
commit id: "3.0/bin" tag: "3.0/bin"
checkout latest-1.0
commit id: "2.0/test" tag: "2.0/test"
```


`git-artifact` has all the functions available that make the above history natural workflow.

### Prerequisites
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.
Expand Down