ga_runs: GitHub runs

In muschellij2/aghast: Another 'GitHub' Actions Service Tool

GitHub runs

Description

GitHub runs

Usage

ga_run_list(owner, repo = NULL, page = NULL, per_page = NULL, ...)

ga_run_table(..., sha = NULL, name = NULL)

ga_run(owner, repo = NULL, run_id, ...)

ga_run_delete(owner, repo = NULL, run_id, ...)

ga_run_cancel(owner, repo = NULL, run_id, ...)

ga_run_download_log(owner, repo = NULL, run_id, ...)

ga_sha_download_log(owner, repo = NULL, sha = NULL, ...)

ga_run_delete_log(owner, repo = NULL, run_id, ...)

ga_run_rerun(owner, repo = NULL, run_id, ...)

ga_run_usage(owner, repo = NULL, run_id, ...)

ga_run_jobs(owner, repo = NULL, run_id, page = NULL, per_page = NULL, ...)

ga_run_jobs_table(..., download_logs = FALSE)

ga_run_artifacts(owner, repo = NULL, run_id, page = NULL, per_page = NULL, ...)

Arguments

owner	owner of repo/username
repo	repository name
page	page to query. If NULL, then will iterate through all pages
per_page	number of results per page.
...	additional arguments to pass to gh::gh()
sha	commit ID sha to cross reference for runs.
name	name of the workflow
run_id	identifier of run
download_logs	should the logs be downloaded for each job?

Value

Answer from the API as a ga_response object, which is also a list. Failed requests will generate an R error. Requests that generate a raw response will return a raw vector.

Examples

## Not run: 
have_token = length(gh::gh_token()) > 0
  if (have_token) {
    runs = ga_run_list("muschellij2", "pycwa")
    tab = ga_run_table("muschellij2", "pycwa")
    tab$head_sha
    run_id = runs$workflow_runs[[1]]$id
  }

  if (have_token) {
    tab = ga_run_table("muschellij2/pycwa@a9cd1b25ba80a17fb5085f165962785f70590565")
    run = ga_run("muschellij2", "pycwa", run_id)
    run_jobs = ga_run_jobs("muschellij2", "pycwa", run_id)
    if (difftime(Sys.time(), as.POSIXct(tab$created_at), "days")<= 90) {
      run_log = ga_run_download_log("muschellij2", "pycwa", run_id)
    }
    usage = ga_run_usage("muschellij2", "pycwa", run_id)
    run_artifacts = ga_run_artifacts("muschellij2", "pycwa", run_id)
  }

## End(Not run)

muschellij2/aghast documentation built on Nov. 7, 2024, 9:36 p.m.