git-tag

The git-tag step creates a new, annotated tag in a local Git repository referencing the current HEAD of a checked-out branch.

Configuration

Name	Type	Required	Description
path	string	Y	Path to a working directory of a local repository. This path is relative to the temporary workspace that Kargo provisions for use by the promotion process.
tag	string	Y	The tag to create.
message	string	Y	The message with which to annotate the tag.

Output

Name	Type	Description
commit	string	The ID (SHA) of the commit pushed by this step.

Examples

Basic Usage

In this example, the git-tag step creates a tag named v1.0.0 in a local Git repository.

steps:
- uses: git-tag
  config:
    path: ./out
    tag: v1.0.0

Tagging After a Commit

This example demonstrates how to use the git-tag step after a git-commit step to tag the latest commit with a version number.

steps:
- uses: git-commit
  config:
    path: ./out
    message: "Committing changes for release v1.0.0"
- uses: git-tag
  config:
    path: ./out
    tag: v1.0.0

Pushing After Tagging

In this example, the git-tag step creates a tag, and the git-push step pushes the tag to the remote repository.

steps:
- uses: git-tag
  config:
    path: ./out
    tag: v1.0.0
- uses: git-push
  config:
    path: ./out
    tag: v1.0.0