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

Linted markdown #3

Merged
merged 2 commits into from
May 17, 2024
Merged

Linted markdown #3

merged 2 commits into from
May 17, 2024

Conversation

MadsNielsen
Copy link
Member

@MadsNielsen MadsNielsen commented Apr 26, 2024

Fixed markdown linter errors in README.md

Summary by CodeRabbit

  • New Features

    • Implemented horizontal commit storage approach using tags for artifact management in Git repositories.
    • Added functionalities for appending artifacts, handling Large File Storage (LFS), and artifact promotions.
    • Enhanced artifact traceability and reproducibility with annotated tags and additional information.
  • Documentation

    • Updated README with detailed information on the new features and advanced functionalities of the git-artifact tool.

Copy link

coderabbitai bot commented Apr 26, 2024

Walkthrough

The git-artifact tool has been significantly enhanced to optimize artifact management within Git repositories. It now employs a horizontal commit storage approach using tags, offering improved artifact handling and traceability. Various new commands and functionalities have been introduced to streamline artifact management workflows, including support for appending artifacts, handling Large File Storage (LFS), and promoting artifacts across repositories.

Changes

File Change Summary
README.md Updated git-artifact tool to use horizontal commit storage with tags, added new commands, and advanced features.

Poem

🐇✨
Amongst the branches and code so grand,
A rabbit's touch refines the land.
Tags like stars in the Git sky above,
Artifacts secure in their tag-woven glove.
With commands new, in the moon's soft light,
Git-artifacts dance, a magical sight.
🌟📂


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 24

@@ -1,134 +1,163 @@
# git-artifact

## The rational for storing artifacts in git

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

README.md Outdated
@@ -1,134 +1,163 @@
# git-artifact

## The rational for storing artifacts in git

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

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 "block chain" to "blockchain" and "distrubuted" to "distributed".

- Git has always been mentioned to be bad for storing artifacts due to the block chain technology and distrubuted architecture.
+ Git has always been mentioned to be bad for storing artifacts due to the blockchain technology and distributed architecture.

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 "horisontally" using tags rather than the default "stacked" way. It gives a few advantages compared to standard usage of git:

Correct "horisontally" to "horizontally".

- Git-artifact make sure this problem is handled by storing commits "horisontally" using tags rather than the default "stacked" way.
+ 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 block chain technology and distrubuted 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:

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

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:

- 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 "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

Triggering of new builds or tests are done the normal way as known from triggering your pipelines of source code - push or pull - simple..

### Save money

You can save additional license and maintainance cost and/or coqnative load by maintaining and using an additional system for artifacts. You can handle it with your current git repository manager.
Copy link

Choose a reason for hiding this comment

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

Correct "maintainance" to "maintenance" and "coqnative" to "cognitive".

- You can save additional license and maintainance cost and/or coqnative load by maintaining and using an additional system for artifacts.
+ You can save additional license and maintenance cost and/or cognitive load by maintaining and using an additional system for artifacts.

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
You can save additional license and maintainance cost and/or coqnative load by maintaining and using an additional system for artifacts. You can handle it with your current git repository manager.
You can save additional license and maintenance cost and/or cognitive load by maintaining and using an additional system for artifacts. You can handle it with your current git repository manager.

A few remarks, aspects and thoughts when storing the artifacts

A few remarks, aspects and thoughts when storing the artifacts

- easy to append artifacts as stages evolves with more artifacts
Copy link

Choose a reason for hiding this comment

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

Start the sentence with an uppercase letter.

- easy to append artifacts as stages evolves with more artifacts
+ Easy to append artifacts as stages evolves with more artifacts

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
- easy to append artifacts as stages evolves with more artifacts
Easy to append artifacts as stages evolves with more artifacts

A few remarks, aspects and thoughts when storing the artifacts

A few remarks, aspects and thoughts when storing the artifacts

- easy to append artifacts as stages evolves with more artifacts
- no need to zip before upload - just commit as the artifact should be used.
- easy to add information, environment, tools and git source sha1 in the artifact for traceability and later reproduction
Copy link

Choose a reason for hiding this comment

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

Start the sentence with an uppercase letter.

- easy to add information, environment, tools and git source sha1 in the artifact for traceability and later reproduction
+ Easy to add information, environment, tools and git source sha1 in the artifact for traceability and later reproduction

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
- easy to add information, environment, tools and git source sha1 in the artifact for traceability and later reproduction
Easy to add information, environment, tools and git source sha1 in the artifact for traceability and later reproduction

README.md Outdated
[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.
Copy link

Choose a reason for hiding this comment

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

Start the sentence with an uppercase letter.

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

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-artifacts` has all the functions available that make the above history straight for and natural workflow.
`Git-artifacts` has all the functions available that make the above history straight for and natural workflow.

cd my-git-artifact-path
cp -rf <build-dir>/my.lib /include .
git artifact add-n-push -t v1.0
```

The artifact v1.0 is now commited, pushed _and_ importantly - the workspace is set back to the default branch of the remote repository. It is now ready to make a new artifact based on the default branched
Copy link

Choose a reason for hiding this comment

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

Correct "commited" to "committed".

- The artifact v1.0 is now commited, pushed _and_ importantly - the workspace is set back to the default branch of the remote repository.
+ The artifact v1.0 is now committed, pushed _and_ importantly - the workspace is set back to the default branch of the remote repository.

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
The artifact v1.0 is now commited, pushed _and_ importantly - the workspace is set back to the default branch of the remote repository. It is now ready to make a new artifact based on the default branched
The artifact v1.0 is now committed, pushed _and_ importantly - the workspace is set back to the default branch of the remote repository. It is now ready to make a new artifact based on the default branched

`git artifact` work great out of the box without any extensions like LFS. It can though still be interesting to commit an `git-lfs` configuration to the default branch.
- Artifact sets that can many common binary/large files from version to version will then be able to detect that it already have have this file in the LFS storage and do not have to fetch/push it again.

`git artifact` work great out of the box without any extensions like LFS. It can though still be interesting to commit an `git-lfs` configuration to the default branch
Copy link

Choose a reason for hiding this comment

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

Start the sentence with an uppercase letter.

- `git artifact` work great out of the box without any extensions like LFS.
+ `Git artifact` works great out of the box without any extensions like LFS.

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 artifact` work great out of the box without any extensions like LFS. It can though still be interesting to commit an `git-lfs` configuration to the default branch
`Git artifact` works great out of the box without any extensions like LFS. It can though still be interesting to commit an `git-lfs` configuration to the default branch

@MadsNielsen MadsNielsen self-assigned this Apr 26, 2024
@bicschneider bicschneider merged commit 1fff8f7 into main May 17, 2024
3 of 4 checks passed
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 13

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 82ed984 and 33dd60c.
Files selected for processing (1)
  • README.md (2 hunks)
Additional Context Used
LanguageTool (24)
README.md (24)

Near line 3: Did you mean “rationale” (=an explanation / underlying reason)?
Context: # git-artifact ## The rational for storing artifacts in git I have, o...


Near line 6: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...ystem. Git is a fantastic zipper it self and you get integrity of workspaces for fre...


Near line 8: This word is normally spelled as one.
Context: ...be bad for storing artifacts due to the block chain technology and distrubuted architecture...


Near line 14: Two consecutive dots
Context: ...s of source code - push or pull - simple.. ### Save money You can save additiona...


Near line 27: It seems that “to” is missing before the verb.
Context: ...y to the artifact. It will then be easy restore the source for diff and debugging ### ...


Near line 33: The verb form ‘do’ does not appear to fit in this context.
Context: ...ts when retrieving the artifacts - The consumer do not need anything than standard git - P...


Near line 35: Two consecutive dots
Context: ...for submodule usage btw ), repo tool or .. - Even a consumer can be a producer by ...


Near line 41: The word “hence” is an adverb that can’t be used like a conjunction, and therefore needs to be separated from the sentence.
Context: ...How is it done Git normally stacks the history hence you cannot delete commit in the middle ...


Near line 41: The abbreviation “i.e.” (= that is) requires two periods.
Context: ...artifact` make a "horizontal" history - i.e the commits are not stacked on top of e...


Near line 81: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...acts. It can also run in branch mode. It can maintain a latest branch which n...


Near line 85: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...s in the PATH, then git can use it as an command like git artifact. It is now ...


Near line 89: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...t artifact` also have command to do that and it states that this repository is "spec...


Near line 101: It seems that the adverb “not” is incorrect in this context.
Context: ...ure the "constumer" desire it. There is not reason to tar or zip it. Git will handling thi...


Near line 101: Modal verbs like ‘can’ or ‘will’ require the following verb to be in its base form.
Context: ...s not reason to tar or zip it. Git will handling this for optimized storage and easiness...


Near line 134: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ... advantage. Let say you create a library and you run a lot of tests in a later stage...


Near line 134: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ...et say you create a library and you run a lot of tests in a later stage and the result i...


Near line 139: Consider adding two commas here.
Context: ...a new artifact ( see above ) You should of course consider this in your naming convension...


Near line 150: The word “checkout” is a noun. The verb is spelled with a white space.
Context: ... it gives the developers easy access to checkout the correct version that was used to bu...


Near line 152: This word is normally spelled as one.
Context: ...y it actually possible to create a full block-chain of everything that was involved in prod...


Near line 160: Two consecutive dots
Context: ...cleaning artifacts TODO: based on count.. ## Advanced ### LFS git artifact w...


Near line 168: The verb form ‘have’ does not seem to be suitable in this context.
Context: ... be able to detect that it already have have this file in the LFS storage and do not...


Near line 169: Use a comma before ‘and’ if it connects two independent clauses (unless they are closely connected and short).
Context: ...u can download all tags without checkout and then you can search for meta-data in th...


Near line 169: Consider a shorter alternative to avoid wordiness.
Context: ...ffering large data transfer and storage in order to clean. ### Promotions There are genra...


Near line 184: There may an error in the verb form ‘be append’.
Context: ...either be a new unrelated tag or it can be append on top if a release candidate tag.

@@ -1,38 +1,46 @@
# git-artifact

## The rational for storing artifacts in 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 term "rational" to "rationale".

- ## The rational for storing artifacts in git
+ ## The rationale for storing artifacts in git

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
## The rationale for storing artifacts in git

@@ -1,38 +1,46 @@
# git-artifact

## The rational for storing artifacts in git

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

Add a comma before "and" to connect two independent clauses.

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

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

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` makes 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" and "distrubuted" to "distributed".

- Git has always been mentioned to be bad for storing artifacts due to the block chain technology and distrubuted architecture.
+ Git has always been mentioned to be bad for storing artifacts due to the blockchain technology and distributed architecture.

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.

Git has always been mentioned to be bad for storing artifacts due to the blockchain technology and distributed architecture. `git-artifact` makes 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: 

- Firstly; You can garbage collect intermidiate artifacts by just deleting the tag
- Secondly; You only fetch what you need - even without using shallow.

### CI/CD integration

Triggering of new builds or tests are done the normal way as known from triggering your pipelines of source code - push or pull - simple..
Copy link

Choose a reason for hiding this comment

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

Remove the extra period.

- Triggering of new builds or tests are done the normal way as known from triggering your pipelines of source code - push or pull - simple..
+ Triggering of new builds or tests are done the normal way as known from triggering your pipelines of source code - push or pull - simple.

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
Triggering of new builds or tests are done the normal way as known from triggering your pipelines of source code - push or pull - simple..
Triggering of new builds or tests are done the normal way as known from triggering your pipelines of source code - push or pull - simple.

A few remarks, aspects and thoughts when storing the artifacts

A few remarks, aspects and thoughts when storing the artifacts

- easy to append artifacts as stages evolves with more artifacts
- no need to zip before upload - just commit as the artifact should be used.
- easy to add information, environment, tools and git source sha1 in the artifact for traceability and later reproduction
- add the source code as a dependency to the artifact. It will then be easy restore the source for diff and debugging
Copy link

Choose a reason for hiding this comment

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

Add "to" before "restore".

- It will then be easy restore the source for diff and debugging
+ It will then be easy to restore the source for diff and debugging

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.

- add the source code as a dependency to the artifact. It will then be easy to restore the source for diff and debugging

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.

It can also run in branch mode. It can maintain a `latest` branch which needs to be force pushed or delete + push rights. The concept is similar to docker concept of `<image>/latest`. It is only important if you want to use tracking branches without using `git-artifact`. It could be in context of `submodules` or `repo manifests`.

### Installation

Download or clone this repo (`git-artifact`) and add make it available in the PATH. Given that `git-artifact` is in the PATH, then `git` can use it as an command like `git artifact`. It is now integrated with git and git is extended.
Copy link

Choose a reason for hiding this comment

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

Use "a" instead of "an" before "command".

- Given that `git-artifact` is in the PATH, then `git` can use it as an command like `git artifact`.
+ Given that `git-artifact` is in the PATH, then `git` can use it as a command like `git artifact`.

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
Download or clone this repo (`git-artifact`) and add make it available in the PATH. Given that `git-artifact` is in the PATH, then `git` can use it as an command like `git artifact`. It is now integrated with git and git is extended.
Download or clone this repo (`git-artifact`) and add make it available in the PATH. Given that `git-artifact` is in the PATH, then `git` can use it as a command like `git artifact`. It is now integrated with git and git is extended.

git artifact init --url=<remote_url> --path my-git-artifact-path
```

### Add the artifact

The repository and path initialize above ready to use. Copy the artifacts to your path in the folder structure the "constumer" desire it. There is not reason to tar or zip it. Git will handling this for optimized storage and easiness.
Copy link

Choose a reason for hiding this comment

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

Correct grammatical errors.

- The repository and path initialize above ready to use. Copy the artifacts to your path in the folder structure the "constumer" desire it. There is not reason to tar or zip it. Git will handling this for optimized storage and easiness.
+ The repository and path initialized above are ready to use. Copy the artifacts to your path in the folder structure the "consumer" desires it. There is no reason to tar or zip it. Git will handle this for optimized storage and easiness.

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
The repository and path initialize above ready to use. Copy the artifacts to your path in the folder structure the "constumer" desire it. There is not reason to tar or zip it. Git will handling this for optimized storage and easiness.
The repository and path initialized above are ready to use. Copy the artifacts to your path in the folder structure the "consumer" desires it. There is no reason to tar or zip it. Git will handle this for optimized storage and easiness.

vX.Y.Z/release-note
vX.Y.Z/test
vX.Y.Z/src
vX.Y.Z/lib
```

### Add the source code that was used to build the artifact

The source code in many companies and open-source projects are free to view, debug and edit. You can make it easy accessable by adding the source code as submodule and sha1 in to the artifact history. It sounds odd, but it gives the developers easy access to checkout the correct version that was used to build artifact.
Copy link

Choose a reason for hiding this comment

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

Correct "checkout" to "check out".

- It sounds odd, but it gives the developers easy access to checkout the correct version that was used to build artifact.
+ It sounds odd, but it gives the developers easy access to check out the correct version that was used to build the artifact.

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
The source code in many companies and open-source projects are free to view, debug and edit. You can make it easy accessable by adding the source code as submodule and sha1 in to the artifact history. It sounds odd, but it gives the developers easy access to checkout the correct version that was used to build artifact.
The source code in many companies and open-source projects are free to view, debug and edit. You can make it easy accessable by adding the source code as submodule and sha1 in to the artifact history. It sounds odd, but it gives the developers easy access to check out the correct version that was used to build the artifact.


`git artifact` work great out of the box without any extensions like LFS. It can though still be interesting to commit an `git-lfs` configuration to the default branch

- Artifact sets that can many common binary/large files from version to version will then be able to detect that it already have have this file in the LFS storage and do not have to fetch/push it again.
Copy link

Choose a reason for hiding this comment

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

Correct the repeated word "have".

- Artifact sets that can many common binary/large files from version to version will then be able to detect that it already have have this file in the LFS storage and do not have to fetch/push it again.
+ Artifact sets that can handle many common binary/large files from version to version will then be able to detect that it already has this file in the LFS storage and does not have to fetch/push it again.

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
- Artifact sets that can many common binary/large files from version to version will then be able to detect that it already have have this file in the LFS storage and do not have to fetch/push it again.
Artifact sets that can handle many common binary/large files from version to version will then be able to detect that it already has this file in the LFS storage and does not have to fetch/push it again.


This way requires you to create a tag using a release tag pattern. The tag can either be a new unrelated tag or it can be append on top if a release candidate 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 verb form "be append" to "be appended".

- The tag can either be a new unrelated tag or it can be append on top if a release candidate tag.
+ The tag can either be a new unrelated tag or it can be appended on top of a release candidate 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
This way requires you to create a tag using a release tag pattern. The tag can either be a new unrelated tag or it can be append on top if a release candidate tag.
This way requires you to create a tag using a release tag pattern. The tag can either be a new unrelated tag or it can be appended on top of a release candidate tag.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants