- Notifications
You must be signed in to change notification settings - Fork0
⚙️ GTO Github Action
iterative/gto-action
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
GTO is open-source tool that helps you turnyour Git repository into an Artifact Registry. Main features:
- Registry: Track new artifacts and their versions for releases and significantchanges.
- Lifecycle Management: Create actionable stages for versions marking status ofartifact or it's readiness to be consumed by a specific environment.
- GitOps: Signal CI/CD automation or other downstream systems to act upon thesenew versions and lifecycle updates.
Theiterative/gto-action action is aDocker-based action that runsGTO againstthe Git tag that triggered CI and finds out what this tag does, whether it's aversion registration, stage assignment or something else. This allows you to actaccordingly upon this event.
v1
of this action relied on GTO-based annotations (written toartifacts.yaml
). Now deprecated.v2
of this action relies on DVC-based annotations(written todvc.yaml
).
This action can be run onubuntu-latest
only for now (let us know if you needmacos-latest
orwindows-latest
).
Basic usage:
steps: -uses:actions/checkout@v3 -id:gtouses:iterative/gto-action@v2
Pulling artifact with DVC:
steps: -uses:actions/checkout@v3 -id:gtouses:iterative/gto-action@v2with:pull:trueenv:AWS_ACCESS_KEY_ID:${{ secrets.AWS_ACCESS_KEY_ID }}AWS_SECRET_ACCESS_KEY:${{ secrets.AWS_SECRET_ACCESS_KEY }}
After pulling, the artifact can be found at${{ steps.gto.outputs.path }}
.For a complete CI example, seethis workflowin the GTO example repo.
The following inputs are supported.
pull
- (optional) Whether to rundvc pull
on the artifacts' path.If set to true, add necessary secrets that DVC will need to access the remote.show
- (optional) Whether to rungto show
.history
- (optional) Whether to rungto history
.print-outputs
- (optional) Whether to print action outputs.
Note if the Git tag that triggered the workflow conforms the GTO format,gto show $NAME
andgto history $NAME
are run each time regardless of theseoptions ($NAME
is the name of artifact Git tag refers to).
event
- Type of triggering eventname
- The name of the artifactversion
- The version of the artifactstage
- The stage - if the events is a stage assignmenttype
- The type of the artifact (if annotated)path
- The path of the artifact (if annotated)description
- The description of the artifact (if annotated)
About
⚙️ GTO Github Action