-
Notifications
You must be signed in to change notification settings - Fork 1
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
Add a readme #7
Conversation
There was a problem hiding this 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! 🙌
@lnovara thank you! I've added a paragraph about the ecosystem, please let me know if it's any good :) |
There was a problem hiding this 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.
5130c7d
to
4415729
Compare
597e042
to
29c8c47
Compare
@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 |
5ccb929
to
9262a0c
Compare
README.md
Outdated
] | ||
}, | ||
"reference": { | ||
"name": "refs/heads/master", |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
... 🙃
There was a problem hiding this comment.
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.
3efc444
to
cd4cdd9
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 💯
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
There was a problem hiding this 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 :)
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.