### Home Classes Methods

### In Files

- lib/github_api/git_data/tags.rb

### Parent

Github::API

### Methods

- #create
- #find
- #get

### Class/Module Index

Quicksearch

- Github
- Github::API
- Github::Activity
- Github::Activity::Events
- Github::Activity::Notifications
- Github::Activity::Starring
- Github::Activity::Watching
- Github::ApiFactory
- Github::Arguments
- Github::Authorization
- Github::Authorizations
- Github::AutoloadHelper
- Github::Client
- Github::Configuration
- Github::Connection
- Github::Constants
- Github::CoreExt
- Github::CoreExt::OrderedHash
- Github::Descendants
- Github::Emojis
- Github::Error
- Github::Error::BadRequest
- Github::Error::ClientError
- Github::Error::Forbidden
- Github::Error::GithubError
- Github::Error::InternalServerError
- Github::Error::InvalidOptions
- Github::Error::NotAcceptable
- Github::Error::NotFound
- Github::Error::RequiredParams
- Github::Error::ServiceError
- Github::Error::ServiceUnavailable
- Github::Error::Unauthorized
- Github::Error::UnknownValue
- Github::Error::UnprocessableEntity
- Github::Error::Validations
- Github::Gists
- Github::Gists::Comments
- Github::GitData
- Github::GitData::Blobs
- Github::GitData::Commits
- Github::GitData::References
- Github::GitData::Tags
- Github::GitData::Trees
- Github::Gitignore
- Github::Issues
- Github::Issues::Assignees
- Github::Issues::Comments
- Github::Issues::Events
- Github::Issues::Labels
- Github::Issues::Milestones
- Github::Jsonable
- Github::Markdown
- Github::Meta
- Github::MimeType
- Github::Normalizer
- Github::Orgs
- Github::Orgs::Members
- Github::Orgs::Teams
- Github::PageIterator
- Github::PageLinks
- Github::PagedRequest
- Github::Pagination
- Github::ParameterFilter
- Github::ParamsHash
- Github::PullRequests
- Github::PullRequests::Comments
- Github::RateLimit
- Github::Repos
- Github::Repos::Collaborators
- Github::Repos::Comments
- Github::Repos::Commits
- Github::Repos::Contents
- Github::Repos::Downloads
- Github::Repos::Forks
- Github::Repos::Hooks
- Github::Repos::Keys
- Github::Repos::Merging
- Github::Repos::PubSubHubbub
- Github::Repos::Statistics
- Github::Repos::Statuses
- Github::Request
- Github::Request::BasicAuth
- Github::Request::Jsonize
- Github::Request::OAuth2
- Github::Resource
- Github::Response
- Github::Response::Header
- Github::Response::Jsonize
- Github::Response::Mashify
- Github::Response::RaiseError
- Github::Response::Xmlize
- Github::ResponseWrapper
- Github::S3Uploader
- Github::Say
- Github::Scopes
- Github::Search
- Github::Users
- Github::Users::Emails
- Github::Users::Followers
- Github::Users::Keys
- Github::Utils
- Github::Utils::Url
- Github::VERSION
- Github::Validations
- Github::Validations::Format
- Github::Validations::Presence
- Github::Validations::Required
- Github::Validations::Token
- Hash

No matching classes.

# Github::GitData::Tags

### Constants

VALID_TAG_PARAM_NAMES

  This tags api only deals with tag objects - so only annotated tags, not lightweight tags.

VALID_TAG_PARAM_VALUES

### Public Instance Methods

create(*args) click to toggle source

Create a tag object Note that creating a tag object does not create the reference that makes a tag in Git. If you want to create an annotated tag in Git, you have to do this call to create the tag object, and then create the `refs/tags/[tag]` reference. If you want to create a lightweight tag, you simply have to create the reference - this call would be unnecessary.

# Parameters

- `:tag` - String of the tag

- `:message` - String of the tag message

- `:object` - String of the SHA of the git object this is tagging

- `:type` - String of the type of the object we're tagging. Normally this is a `commit` but it can also be a `tree` or a `blob`

- tagger.name | String of the name of the author of the tag

- tagger.email | String of the email of the author of the tag

- tagger.date | Timestamp of when this object was tagged

# Examples

    github = Github.new
    github.git_data.tags.create 'user-name', 'repo-name',
      "tag" => "v0.0.1",
      "message" => "initial version\n",
      "type" => "commit",
      "object" => "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
      "tagger" => {
        "name" => "Scott Chacon",
        "email" => "schacon@gmail.com",
        "date" => "2011-06-17T14:53:3"
      }

    # File lib/github_api/git_data/tags.rb, line 66
    def create(*args)
      arguments(args, :required => [:user, :repo]) do
        sift VALID_TAG_PARAM_NAMES
        assert_values VALID_TAG_PARAM_VALUES
      end
      params = arguments.params

      post_request("/repos/#{user}/#{repo}/git/tags", params)
    end

find(*args) click to toggle source
Alias for: get
get(*args) click to toggle source

Get a tag

# Examples

    github = Github.new
    github.git_data.tags.get 'user-name', 'repo-name', 'sha'

    # File lib/github_api/git_data/tags.rb, line 30
    def get(*args)
      arguments(args, :required => [:user, :repo, :sha])
      params = arguments.params

      get_request("/repos/#{user}/#{repo}/git/tags/#{sha}", params)
    end

Also aliased as: find

[Validate]

Generated with the Darkfish Rdoc Generator 2.