Polykey icon indicating copy to clipboard operation
Polykey copied to clipboard

Add user-defined tags for vault versions

Open joshuakarp opened this issue 4 years ago • 0 comments

Specification

The vault version command currently requires the use of a commit ID to move between versions of a vault. This issue would introduce tags, such that a user can add a string tag to a particular commit ID to be used in place of the commit ID, improving usability of moving between vault versions.

For example, consider a vault v1 with commit log: c1 -> c2 -> c3, where c1, c2 and c3 would each have a commit ID (such as e49edb7a6d7a14f3763a6325e246bab838a19b6c).

Instead of performing the command pk vaults v1 version e49edb7a6d7a14f3763a6325e246bab838a19b6c, a user could define a tag to move to this particular commit. For example, pk vaults v1 version old-password (where old-password is the tag).

Additional context

  • originally proposed by @tegefaulkes here https://gitlab.com/MatrixAI/Engineering/Polykey/js-polykey/-/merge_requests/205#note_698557707
  • supported by iso-git here https://isomorphic-git.org/docs/en/tag

Tasks

  1. ...
  2. ...
  3. ...

joshuakarp avatar Oct 21 '21 00:10 joshuakarp