Module: Octokit::Client::ActionsWorkflows

Included in:
Octokit::Client
Defined in:
lib/octokit/client/actions_workflows.rb

Overview

Methods for the Actions Workflows API

Instance Method Summary collapse

Instance Method Details

#workflow(repo, id, options = {}) ⇒ Sawyer::Resource

Get single workflow in a repository

Parameters:

  • repo (Integer, String, Repository, Hash)

    A GitHub repository

  • id (Integer, String)

    Id or file name of the workflow

Returns:

  • (Sawyer::Resource)

    A single workflow

See Also:


26
27
28
# File 'lib/octokit/client/actions_workflows.rb', line 26

def workflow(repo, id, options = {})
  get "#{Repository.path repo}/actions/workflows/#{id}", options
end

#workflow_dispatch(repo, id, ref, options = {}) ⇒ Boolean

Create a workflow dispatch event

Parameters:

  • repo (Integer, String, Repository, Hash)

    A GitHub repository

  • id (Integer, String)

    Id or file name of the workflow

  • ref (String)

    A SHA, branch name, or tag name

Returns:

  • (Boolean)

    True if event was dispatched, false otherwise

See Also:


38
39
40
# File 'lib/octokit/client/actions_workflows.rb', line 38

def workflow_dispatch(repo, id, ref, options = {})
  boolean_from_response :post, "#{Repository.path repo}/actions/workflows/#{id}/dispatches", options.merge({ ref: ref })
end

#workflows(repo, options = {}) ⇒ Sawyer::Resource Also known as: list_workflows

Get the workflows in a repository

Parameters:

  • repo (Integer, String, Repository, Hash)

    A GitHub repository

Returns:

  • (Sawyer::Resource)

    the total count and an array of workflows

See Also:


14
15
16
# File 'lib/octokit/client/actions_workflows.rb', line 14

def workflows(repo, options = {})
  paginate "#{Repository.path repo}/actions/workflows", options
end