Update docs for `0.3.0`
aguschin opened this issue · 4 comments
0.3.0 deprecated annotate
, remove
and describe
. We should account for that.
Question: are they really deprecated? or they work on dvc.yaml instead of artifacts.yaml? Which command will replace them then? Will you move these commands to dvc?
In 0.3.0, I removed them @francesco086. Now, there is DVC API to read and add new artifact annotations though (somewhat obscure, e.g. dvc.Repo(".").artifacts.read()
. So what's missing is a CLI support in DVC, and API/CLI in GTO (that calls DVC API under the hood I guess).
I think re-implementing gto annotate/describe
that work with dvc.yaml
would be good (at least describe
), since adding same commands to DVC CLI will be more involved and time-consuming. Besides, if we make them work here, it'll be way faster to create PR to DVC (and then the PR will be adjusted obviously).
What matters here, is there a clear use case for gto describe
after dvc get . mymodel#prod
or dvc get . mymodel@latest
are implemented? And is there a clear need on adding artifacts from CLI? This is something I'd like to understand - it'll help prioritize these things.
In 0.3.0, I removed them @francesco086.
What do you mean by removed? I can still see them...
❯ gto --version
🪴 GTO Version: 0.3.1
❯ gto -h
Usage: gto [OPTIONS] COMMAND [ARGS]...
Git Tag Ops. Turn your Git repository into an Artifact Registry:
* Registry: Track new artifacts and their versions for releases and significant
changes.
* Lifecycle Management: Create actionable stages for versions marking status of
artifact or it's readiness to be consumed by a specific environment.
* GitOps: Signal CI/CD automation or other downstream systems to act upon these
new versions and lifecycle updates.
Options:
--version Show version and exit
-v, --verbose Print debug messages
-h, --help Show this message and exit.
Read the registry:
check-ref Find out the artifact version registered/assigned with ref.
doctor Display GTO version and check the registry for problems.
history Show a journal of registry operations.
show Show the registry state, highest version, or what's assigned...
stages Print list of stages used in the registry.
Modify artifacts:
assign (promote) Assign stage to specific artifact version.
deprecate Deprecate artifact, deregister a version, or unassign a
stage.
register Create an artifact version to signify an important,...
@francesco086, sorry, I think I'm misunderstanding you. The output you posted doesn't have annotate
, remove
and describe
because they were deprecated in 0.3.x
. Did you mean something else?