Skip to content

Create annotated tags in the Release CLI

Release notes

Previously, you were only able to create lightweight tags when using the release-cli to create a release. With this update, you can now add an optional tag-message parameter to create an annotated tag when creating a release. This enables you to include relevant information along with the new tag so downstream users and application can have additional context.

Problem

With --tag-name we can create a tag to go with the release, but that's apparently a lightweight tag. For some applications we want annotated tags (e.g., with git describe, by default). It would be great if this was supported too.

Implementation

Once gitlab#268018 (closed) is done we can add a --tag-message flag to the release-cli

  • Support sending --tag-message to the Releases API
  • Add a --tag-message flag to the release-cli and update docs

You can use #43 (closed) as a guide

Edited by Chris Balane