Class: Ansible::Ruby::Modules::Github_release

Inherits:

Base

• Object
• Ansible::Ruby::Models::Base
• Base
• Ansible::Ruby::Modules::Github_release

Defined in:

lib/ansible/ruby/modules/generated/source_control/github_release.rb

Overview

Fetch metadata about GitHub Releases

Instance Method Summary

• #action ⇒ :latest_release, :create_release

  Action to perform.

• #body ⇒ String^?

  Description of the release when creating a release.

• #draft ⇒ :yes, ...

  Sets if the release is a draft or not.

• #name ⇒ String^?

  Name of release when creating a release.

• #password ⇒ String^?

  The GitHub account password for the user.

• #prerelease ⇒ :yes, ...

  Sets if the release is a prerelease or not.

• #repo ⇒ String

  Repository name.

• #tag ⇒ String^?

  Tag name when creating a release.

• #target ⇒ String^?

  Target of release when creating a release.

• #token ⇒ String^?

  GitHub Personal Access Token for authenticating.

• #user ⇒ String

  The GitHub account that owns the repository.

Methods inherited from Base

#ansible_name, #to_h

Methods inherited from Ansible::Ruby::Models::Base

attr_option, attr_options, attribute, fix_inclusion, #initialize, remove_existing_validations, #to_h, validates

Constructor Details

This class inherits a constructor from Ansible::Ruby::Models::Base

Instance Method Details

#action ⇒ :latest_release, :create_release

Returns Action to perform.

Returns:

• (:latest_release, :create_release) —

  Action to perform

# File 'lib/ansible/ruby/modules/generated/source_control/github_release.rb', line 28

attribute :action

#body ⇒ String^?

Returns Description of the release when creating a release.

Returns:

• (String, nil) —

  Description of the release when creating a release

# File 'lib/ansible/ruby/modules/generated/source_control/github_release.rb', line 44

attribute :body

#draft ⇒ :yes, ...

Returns Sets if the release is a draft or not. (boolean).

Returns:

• (:yes, :no, nil) —

  Sets if the release is a draft or not. (boolean)

# File 'lib/ansible/ruby/modules/generated/source_control/github_release.rb', line 48

attribute :draft

#name ⇒ String^?

Returns Name of release when creating a release.

Returns:

• (String, nil) —

  Name of release when creating a release

# File 'lib/ansible/ruby/modules/generated/source_control/github_release.rb', line 40

attribute :name

#password ⇒ String^?

Returns The GitHub account password for the user.

Returns:

• (String, nil) —

  The GitHub account password for the user

# File 'lib/ansible/ruby/modules/generated/source_control/github_release.rb', line 20

attribute :password

#prerelease ⇒ :yes, ...

Returns Sets if the release is a prerelease or not. (boolean).

Returns:

• (:yes, :no, nil) —

  Sets if the release is a prerelease or not. (boolean)

# File 'lib/ansible/ruby/modules/generated/source_control/github_release.rb', line 52

attribute :prerelease

#repo ⇒ String

Returns Repository name.

Returns:

• (String) —

  Repository name

# File 'lib/ansible/ruby/modules/generated/source_control/github_release.rb', line 24

attribute :repo

#tag ⇒ String^?

Returns Tag name when creating a release. Required when using action is set to C(create_release).

Returns:

• (String, nil) —

  Tag name when creating a release. Required when using action is set to C(create_release).

# File 'lib/ansible/ruby/modules/generated/source_control/github_release.rb', line 32

attribute :tag

#target ⇒ String^?

Returns Target of release when creating a release.

Returns:

• (String, nil) —

  Target of release when creating a release

# File 'lib/ansible/ruby/modules/generated/source_control/github_release.rb', line 36

attribute :target

#token ⇒ String^?

Returns GitHub Personal Access Token for authenticating.

Returns:

• (String, nil) —

  GitHub Personal Access Token for authenticating

# File 'lib/ansible/ruby/modules/generated/source_control/github_release.rb', line 12

attribute :token

#user ⇒ String

Returns The GitHub account that owns the repository.

Returns:

• (String) —

  The GitHub account that owns the repository

# File 'lib/ansible/ruby/modules/generated/source_control/github_release.rb', line 16

attribute :user