Module Gitlab::Client::Tags
In: lib/gitlab/client/tags.rb

Methods

create_release   create_tag   delete_tag   repo_create_release   repo_create_tag   repo_delete_tag   repo_tag   repo_tags   repo_update_release   tag   tags   update_release  

Public Instance methods

create_release(project, tag, description)

Adds release notes to an existing repository tag. Requires Gitlab >= 8.2.0

@example 

  Gitlab.create_release(3, '1.0.0', 'This is ready for production')
  Gitlab.repo_create_release(5, '1.0.0', 'This is ready for production')

@param [Integer] project The ID of a project. @param [String] tag The name of the new tag. @param [String] description Release notes with markdown support @return [Gitlab::ObjectifiedHash]

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

Creates a new project repository tag.

@example 

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

@param [Integer] project The ID of a project. @param [String] tag_name The name of the new tag. @param [String] ref The ref (commit sha, branch name, or another tag) the tag will point to. @param [String] message Optional message for tag, creates annotated tag if specified. @param [String] description Optional release notes for tag. @return [Gitlab::ObjectifiedHash]

delete_tag(project, tag)

Deletes a repository tag. Requires Gitlab >= 6.8.x

@example 

  Gitlab.delete_tag(3, 'api')
  Gitlab.repo_delete_tag(5, 'master')

@param [Integer] project The ID of a project. @param [String] tag The name of the tag to delete @return [Gitlab::ObjectifiedHash]

repo_create_release(project, tag, description)

Alias for create_release

repo_create_tag(project, tag_name, ref, message='', description=nil)

Alias for create_tag

repo_delete_tag(project, tag)

Alias for delete_tag

repo_tag(project, tag)

Alias for tag

repo_tags(project, options={})

Alias for tags

repo_update_release(project, tag, description)

Alias for update_release

tag(project, tag)

Gets information about a repository tag.

@example 

  Gitlab.tag(3, 'api')
  Gitlab.repo_tag(5, 'master')

@param [Integer] project The ID of a project. @param [String] tag The name of the tag. @return [Gitlab::ObjectifiedHash]

tags(project, options={})

Gets a list of project repository tags.

@example 

  Gitlab.tags(42)

@param [Integer] project The ID of a project. @param [Hash] options A customizable set of options. @option options [Integer] :page The page number. @option options [Integer] :per_page The number of results per page. @return [Array<Gitlab::ObjectifiedHash>]

update_release(project, tag, description)

Updates the release notes of a given release. Requires Gitlab >= 8.2.0

@example 

  Gitlab.update_release(3, '1.0.0', 'This is even more ready for production')
  Gitlab.repo_update_release(5, '1.0.0', 'This is even more ready for production')

@param [Integer] project The ID of a project. @param [String] tag The name of the new tag. @param [String] description Release notes with markdown support @return [Gitlab::ObjectifiedHash]

[Validate]