github.com/google/go-github/v49@v49.1.0/github/actions_workflow_jobs.go (about)

     1  // Copyright 2020 The go-github AUTHORS. All rights reserved.
     2  //
     3  // Use of this source code is governed by a BSD-style
     4  // license that can be found in the LICENSE file.
     5  
     6  package github
     7  
     8  import (
     9  	"context"
    10  	"fmt"
    11  	"net/http"
    12  	"net/url"
    13  )
    14  
    15  // TaskStep represents a single task step from a sequence of tasks of a job.
    16  type TaskStep struct {
    17  	Name        *string    `json:"name,omitempty"`
    18  	Status      *string    `json:"status,omitempty"`
    19  	Conclusion  *string    `json:"conclusion,omitempty"`
    20  	Number      *int64     `json:"number,omitempty"`
    21  	StartedAt   *Timestamp `json:"started_at,omitempty"`
    22  	CompletedAt *Timestamp `json:"completed_at,omitempty"`
    23  }
    24  
    25  // WorkflowJob represents a repository action workflow job.
    26  type WorkflowJob struct {
    27  	ID          *int64      `json:"id,omitempty"`
    28  	RunID       *int64      `json:"run_id,omitempty"`
    29  	RunURL      *string     `json:"run_url,omitempty"`
    30  	NodeID      *string     `json:"node_id,omitempty"`
    31  	HeadSHA     *string     `json:"head_sha,omitempty"`
    32  	URL         *string     `json:"url,omitempty"`
    33  	HTMLURL     *string     `json:"html_url,omitempty"`
    34  	Status      *string     `json:"status,omitempty"`
    35  	Conclusion  *string     `json:"conclusion,omitempty"`
    36  	StartedAt   *Timestamp  `json:"started_at,omitempty"`
    37  	CompletedAt *Timestamp  `json:"completed_at,omitempty"`
    38  	Name        *string     `json:"name,omitempty"`
    39  	Steps       []*TaskStep `json:"steps,omitempty"`
    40  	CheckRunURL *string     `json:"check_run_url,omitempty"`
    41  	// Labels represents runner labels from the `runs-on:` key from a GitHub Actions workflow.
    42  	Labels          []string `json:"labels,omitempty"`
    43  	RunnerID        *int64   `json:"runner_id,omitempty"`
    44  	RunnerName      *string  `json:"runner_name,omitempty"`
    45  	RunnerGroupID   *int64   `json:"runner_group_id,omitempty"`
    46  	RunnerGroupName *string  `json:"runner_group_name,omitempty"`
    47  	RunAttempt      *int64   `json:"run_attempt,omitempty"`
    48  }
    49  
    50  // Jobs represents a slice of repository action workflow job.
    51  type Jobs struct {
    52  	TotalCount *int           `json:"total_count,omitempty"`
    53  	Jobs       []*WorkflowJob `json:"jobs,omitempty"`
    54  }
    55  
    56  // ListWorkflowJobsOptions specifies optional parameters to ListWorkflowJobs.
    57  type ListWorkflowJobsOptions struct {
    58  	// Filter specifies how jobs should be filtered by their completed_at timestamp.
    59  	// Possible values are:
    60  	//     latest - Returns jobs from the most recent execution of the workflow run
    61  	//     all - Returns all jobs for a workflow run, including from old executions of the workflow run
    62  	//
    63  	// Default value is "latest".
    64  	Filter string `url:"filter,omitempty"`
    65  	ListOptions
    66  }
    67  
    68  // ListWorkflowJobs lists all jobs for a workflow run.
    69  //
    70  // GitHub API docs: https://docs.github.com/en/rest/actions/workflow-jobs#list-jobs-for-a-workflow-run
    71  func (s *ActionsService) ListWorkflowJobs(ctx context.Context, owner, repo string, runID int64, opts *ListWorkflowJobsOptions) (*Jobs, *Response, error) {
    72  	u := fmt.Sprintf("repos/%s/%s/actions/runs/%v/jobs", owner, repo, runID)
    73  	u, err := addOptions(u, opts)
    74  	if err != nil {
    75  		return nil, nil, err
    76  	}
    77  
    78  	req, err := s.client.NewRequest("GET", u, nil)
    79  	if err != nil {
    80  		return nil, nil, err
    81  	}
    82  
    83  	jobs := new(Jobs)
    84  	resp, err := s.client.Do(ctx, req, &jobs)
    85  	if err != nil {
    86  		return nil, resp, err
    87  	}
    88  
    89  	return jobs, resp, nil
    90  }
    91  
    92  // GetWorkflowJobByID gets a specific job in a workflow run by ID.
    93  //
    94  // GitHub API docs: https://docs.github.com/en/rest/actions/workflow-jobs#get-a-job-for-a-workflow-run
    95  func (s *ActionsService) GetWorkflowJobByID(ctx context.Context, owner, repo string, jobID int64) (*WorkflowJob, *Response, error) {
    96  	u := fmt.Sprintf("repos/%v/%v/actions/jobs/%v", owner, repo, jobID)
    97  
    98  	req, err := s.client.NewRequest("GET", u, nil)
    99  	if err != nil {
   100  		return nil, nil, err
   101  	}
   102  
   103  	job := new(WorkflowJob)
   104  	resp, err := s.client.Do(ctx, req, job)
   105  	if err != nil {
   106  		return nil, resp, err
   107  	}
   108  
   109  	return job, resp, nil
   110  }
   111  
   112  // GetWorkflowJobLogs gets a redirect URL to download a plain text file of logs for a workflow job.
   113  //
   114  // GitHub API docs: https://docs.github.com/en/rest/actions/workflow-jobs#download-job-logs-for-a-workflow-run
   115  func (s *ActionsService) GetWorkflowJobLogs(ctx context.Context, owner, repo string, jobID int64, followRedirects bool) (*url.URL, *Response, error) {
   116  	u := fmt.Sprintf("repos/%v/%v/actions/jobs/%v/logs", owner, repo, jobID)
   117  
   118  	resp, err := s.client.roundTripWithOptionalFollowRedirect(ctx, u, followRedirects)
   119  	if err != nil {
   120  		return nil, nil, err
   121  	}
   122  	defer resp.Body.Close()
   123  
   124  	if resp.StatusCode != http.StatusFound {
   125  		return nil, newResponse(resp), fmt.Errorf("unexpected status code: %s", resp.Status)
   126  	}
   127  
   128  	parsedURL, err := url.Parse(resp.Header.Get("Location"))
   129  	return parsedURL, newResponse(resp), err
   130  }