Sha256: 46823c2e19655049ba0011b69f7f88822584646ac09b5320e2318f1d07af0607

Contents?: true

Size: 1.27 KB

Versions: 6

Compression:

Stored size: 1.27 KB

Contents

module Octokit
  class Client
    module Gitignore

      # Listing available gitignore templates.
      #
      # These templates can be passed option when creating a repository.
      #
      # @see http://developer.github.com/v3/gitignore/#listing-available-templates
      # @see http://developer.github.com/v3/repos/#create
      #
      # @return [Array<String>] List of templates.
      #
      # @example Git all the gitignore templates
      #   @client.gitignore_templates
      def gitignore_templates(options={})
        get "/gitignore/templates", options
      end

      # Get a gitignore template.
      #
      # Use the raw {http://developer.github.com/v3/media/ media type} to get
      # the raw contents.
      #
      # @param template_name [String] Name of the template. Template names are
      #   case sensitive, make sure to use a valid name from the 
      #   .gitignore_templates list.
      #
      # @see http://developer.github.com/v3/gitignore/#get-a-single-template
      #
      # @return [Hash] Gitignore template
      #
      # @example Get the Ruby gitignore template
      #   @client.gitignore_template('Ruby')
      def gitignore_template(template_name, options={})
        get "/gitignore/templates/#{template_name}", options
      end

    end
  end
end

Version data entries

6 entries across 6 versions & 1 rubygems

Version Path
octokit-1.25.0 lib/octokit/client/gitignore.rb
octokit-1.24.0 lib/octokit/client/gitignore.rb
octokit-1.23.0 lib/octokit/client/gitignore.rb
octokit-1.22.0 lib/octokit/client/gitignore.rb
octokit-1.21.0 lib/octokit/client/gitignore.rb
octokit-1.20.0 lib/octokit/client/gitignore.rb