Class: CIRunner::Check::Github

Inherits:

Base

• Object
• Base
• CIRunner::Check::Github

Defined in:

lib/ci_runner/check/github.rb

Overview

Check class used when a project is configured to run its CI using GitHub actions.

See Also:

• https://docs.github.com/en/rest/actions/workflow-jobs

Instance Attribute Summary

• #id ⇒ Object readonly

  :private:.

Attributes inherited from Base

#commit, #name, #repository, #status

Instance Method Summary

• #download_log ⇒ See Client::Github#download_log

  Download the log output for thig GitHub build.

• #initialize(*args, id) ⇒ Github constructor

  A new instance of Github.

• #provider ⇒ String

  Used to tell the user which CI provider we are downloading the log output from.

Methods inherited from Base

#failed?, #success?

Constructor Details

#initialize(*args, id) ⇒ Github

Returns a new instance of Github.

Parameters:

• args (See Base#initialize)
• id (Integer) —

  The ID of this check.

# File 'lib/ci_runner/check/github.rb', line 15

def initialize(*args, id)
  super(*args)

  @id = id
end

Instance Attribute Details

#id ⇒ Object (readonly)

:private:

# File 'lib/ci_runner/check/github.rb', line 11

def id
  @id
end

Instance Method Details

#download_log ⇒ See Client::Github#download_log

Download the log output for thig GitHub build.

Returns:

• (See Client::Github#download_log)

See Also:

• https://docs.github.com/en/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run

# File 'lib/ci_runner/check/github.rb', line 33

def download_log
  github_client = Client::Github.new(Configuration::User.instance.github_token)

  github_client.download_log(@repository, @id)
end

#provider ⇒ String

Used to tell the user which CI provider we are downloading the log output from.

Returns:

• (String)

# File 'lib/ci_runner/check/github.rb', line 24

def provider
  "GitHub"
end