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

Add a readme #7

Merged
merged 1 commit into from
Sep 7, 2023
Merged

Add a readme #7

merged 1 commit into from
Sep 7, 2023

Conversation

errordeveloper
Copy link
Contributor

@errordeveloper errordeveloper commented Aug 25, 2023

It's long overdue! I know that more detailed usage examples would be quite good, but I'd leave that for the next PR.

I'm really keen to hear feedback about the description, whether it's clear enough or a bit too "out there"... Please do keep in mind that this tool is relatively low-level, it's currently for the kind of users who'd otherwise run flux push artifact or possibly go DIY.

Copy link

@lnovara lnovara left a comment

Choose a reason for hiding this comment

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

Following a call with @errordeveloper, I try to summarise my thoughts about Tape.

I really like the simplicity of the tool and how it helps in framing the configuration as data.

I would better highlight Tape's relation with tools such as Kustomize and Helm and also that, right now, adoption of Tape is limited to Flux users since AFAIK is the only GitOps tool that understands OCI artifacts.

Nice work! 🙌

@errordeveloper
Copy link
Contributor Author

@lnovara thank you! I've added a paragraph about the ecosystem, please let me know if it's any good :)

README.md Show resolved Hide resolved
Copy link

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

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

I would replace artefact with artifact, as this is the spelling used by OCI, Flux, etc.

README.md Outdated Show resolved Hide resolved
@errordeveloper
Copy link
Contributor Author

errordeveloper commented Aug 29, 2023

@stefanprodan @slimslenderslacks both of you mentioned that showing OCI JSON manifests would be helpful, I've added an example that shows all that there is. PTAL, whenever you have a chance =)

It's quite verbose, maybe I can use <details/> for some of these JSON objects, but the readme is a bit wordy overall anyway, I wish it to be shorter. Perhaps I can worry about that later.

README.md Outdated
]
},
"reference": {
"name": "refs/heads/master",

Choose a reason for hiding this comment

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

At the top there is git switch 6.4.1 but in here in shows master. I suggest to redo examples for the Git tag.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

git switch 6.4.1 actually fails, have to use git switch --detach 6.4.1... 🙃

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Well spotted! I've fixed the output and opened #13 to address tags in attestations.

Copy link

@stefanprodan stefanprodan left a comment

Choose a reason for hiding this comment

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

LGTM 💯

Copy link

@ipedrazas ipedrazas left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link

@kipz kipz left a comment

Choose a reason for hiding this comment

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

Minor language suggestions. Feel free to ignore. Looks good to me :)

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@errordeveloper errordeveloper merged commit 88f5a00 into main Sep 7, 2023
1 check passed
@errordeveloper errordeveloper deleted the readme branch September 7, 2023 16:15
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.

5 participants