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

Make the commands less surprising #65

Open
mikberg opened this issue Mar 10, 2022 · 0 comments
Open

Make the commands less surprising #65

mikberg opened this issue Mar 10, 2022 · 0 comments

Comments

@mikberg
Copy link
Contributor

mikberg commented Mar 10, 2022

When writing docs and relatively thoroughly going through the API now, I found a number of things that were somewhat surprising:

  • We are mixing up the idea of a "snapshot name" and the path to the snapshot.
  • The snapshot name defaults to git rev-parse HEAD, but this isn't really documented, and feels a bit surprising. This might still be somewhat practical in the collect command, but feels very unintuitive in the push and tag commands.
  • The diff outputs just a list of targets by default. I think most will use the JSON output format.
  • The collect command can optionally also push the snapshot to remote storage, and I think it's debatable what value this brings. I think the clarity of doing this in two commands would be preferable. As far as I know, no-one is using this feature.
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

No branches or pull requests

1 participant