module Gitlab::Client::Tags

def create_release(project, tag, description)

Returns:
  • (Gitlab::ObjectifiedHash) -

Parameters:
  • description (String) -- Release notes with markdown support
  • tag (String) -- The name of the new tag.
  • project (Integer, String) -- The ID or name of a project. 
def create_release(project, tag, description)
  post("/projects/#{url_encode project}/repository/tags/#{url_encode tag}/release", body: { description: description })
end

def create_tag(project, tag_name, ref, message = '', description = nil)

Returns:
  • (Gitlab::ObjectifiedHash) -

Parameters:
  • description (String) -- Optional release notes for tag.
  • message (String) -- Optional message for tag, creates annotated tag if specified.
  • ref (String) -- The ref (commit sha, branch name, or another tag) the tag will point to.
  • tag_name (String) -- The name of the new tag.
  • project (Integer, String) -- The ID or name of a project. 
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

def delete_tag(project, tag)

Returns:
  • (Gitlab::ObjectifiedHash) -

Parameters:
  • tag (String) -- The name of the tag to delete
  • project (Integer, String) -- The ID or name of a project. 
def delete_tag(project, tag)
  delete("/projects/#{url_encode project}/repository/tags/#{url_encode tag}")
end

def tag(project, tag)

Returns:
  • (Gitlab::ObjectifiedHash) -

Parameters:
  • tag (String) -- The name of the tag.
  • project (Integer, String) -- The ID or name of a project. 
def tag(project, tag)
  get("/projects/#{url_encode project}/repository/tags/#{url_encode tag}")
end

def tags(project, options = {})

Returns:
  • (Array) -

Options Hash: (**options)
  • :per_page (Integer) -- The number of results per page.
  • :page (Integer) -- The page number.

Parameters:
  • options (Hash) -- A customizable set of options.
  • project (Integer, String) -- The ID or name of a project. 
def tags(project, options = {})
  get("/projects/#{url_encode project}/repository/tags", query: options)
end

def update_release(project, tag, description)

Returns:
  • (Gitlab::ObjectifiedHash) -

Parameters:
  • description (String) -- Release notes with markdown support
  • tag (String) -- The name of the new tag.
  • project (Integer, String) -- The ID or name of a project. 
def update_release(project, tag, description)
  put("/projects/#{url_encode project}/repository/tags/#{url_encode tag}/release", body: { description: description })
end