Method: Gitlab::Client::Tags#create_tag

Defined in:
lib/gitlab/client/tags.rb

#create_tag(project, tag_name, ref, message = '', description = nil) ⇒ Gitlab::ObjectifiedHash Also known as: repo_create_tag

Creates a new project repository tag.

Examples:

Gitlab.create_tag(42, 'new_tag', 'master')
Gitlab.create_tag(42, 'v1.0', 'master', 'Release 1.0')

Parameters:

  • project (Integer, String) —

    The ID or name of a project.

  • tag_name (String) —

    The name of the new tag.

  • ref (String) —

    The ref (commit sha, branch name, or another tag) the tag will point to.

  • message (String) (defaults to: '') —

    Optional message for tag, creates annotated tag if specified.

  • description (String) (defaults to: nil) —

    Optional release notes for tag.

Returns:


34
35
36
 
# File 'lib/gitlab/client/tags.rb', line 34

def create_tag(project, tag_name, ref, message = '', description = nil)
  post("/projects/#{url_encode project}/repository/tags", body: { tag_name: tag_name, ref: ref, message: message, release_description: description })
end