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

lakectl | tags command are not clear #2409

Closed
guy-har opened this issue Aug 26, 2021 · 2 comments · Fixed by #3017
Closed

lakectl | tags command are not clear #2409

guy-har opened this issue Aug 26, 2021 · 2 comments · Fixed by #3017
Labels
area/lakectl Issues related to lakeFS' command line interface (lakectl) contributor good first issue Good for newcomers

Comments

@guy-har
Copy link
Contributor

guy-har commented Aug 26, 2021

Using lakectl, It is not clear how to create a tag.
The message in help is

Usage:
  lakectl tag create <tag uri> <commit ref> [flags]

The command expects tag uri to be a full URI
And commit ref to be only the commit ref with out the uri
A valid command would be

lakectl tag create lakefs://example1/my-tag 2397cc9a9d04c20a4e5739b42c1dd3d8ba655c0b3a3b974850895a13d8bf9917

First of all to make this command clear we should add an example in the command help

Second, we should make commit ref a full URI, weather the tag should be a full URI is debatable (the user I talked to expected the tag to be without a full URI).

@guy-har guy-har added area/lakectl Issues related to lakeFS' command line interface (lakectl) contributor labels Aug 26, 2021
@ozkatz ozkatz added the good first issue Good for newcomers label Sep 26, 2021
@mishraprafful
Copy link
Contributor

mishraprafful commented Feb 2, 2022

@guy-har I've created a PR adding the example, about the second change mentioned in the issue description, I think it makes sense to keep the command the way it is (from my perspective as a user).

Adding the full URI to the commit ref, gives me a sense of hope that I can specify commit ref for a different repo, which clearly doesn't seem right.

But I would love to hear your thoughts about it.

@guy-har
Copy link
Contributor Author

guy-har commented Feb 2, 2022

@mishraprafful, my problem here is that this behavior breaks the convention we currently have.
The other commands we have (such as merge and diff) receive two full URIs regardless of the fact that you can't specify refs from different repos.
Your claim makes perfect sense, but I'm afraid that having both practices could cause confusion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/lakectl Issues related to lakeFS' command line interface (lakectl) contributor good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants