github

package

v1.32.0-160.1 Latest Latest Go to latest Published: Jul 28, 2026 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/temporalio/temporal

Links

Open Source Insights

Documentation ¶

Index ¶

func CommitURL(repo, sha string) string
func DownloadArtifact(ctx context.Context, repo string, artifactID int64, outputDir string) (string, error)
func JobURL(repo, runID, jobID string) string
func RunDownload(ctx context.Context, runID string, opts RunDownloadOptions) error
func RunURL(repo, runID string) string
type Artifact
- func ListRunArtifacts(ctx context.Context, repo string, runID int64) ([]Artifact, error)
type Commit
- func GetCommit(ctx context.Context, repo, sha string) (Commit, error)
- func (c Commit) Filenames() []string
- func (c Commit) Title() string
type CommitAuthor
type CommitDetails
type CommitFile
type Conclusion
type Job
type Run
- func ListRuns(ctx context.Context, opts RunListOptions) ([]Run, error)
- func ViewRun(ctx context.Context, runID string) (Run, error)
- func (r Run) ShortSHA() string
type RunDownloadOptions
type RunListOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CommitURL ¶

func CommitURL(repo, sha string) string

CommitURL constructs a GitHub commit URL.

func DownloadArtifact ¶

func DownloadArtifact(ctx context.Context, repo string, artifactID int64, outputDir string) (string, error)

DownloadArtifact downloads a single GitHub Actions artifact zip file.

func JobURL ¶

func JobURL(repo, runID, jobID string) string

JobURL constructs a GitHub Actions job URL.

func RunDownload ¶

func RunDownload(ctx context.Context, runID string, opts RunDownloadOptions) error

RunDownload executes `gh run download`.

func RunURL ¶

func RunURL(repo, runID string) string

RunURL constructs a GitHub Actions workflow run URL.

Types ¶

type Artifact ¶

type Artifact struct {
	ID        int64     `json:"id"`
	Name      string    `json:"name"`
	CreatedAt time.Time `json:"created_at"`
	Expired   bool      `json:"expired"`
}

Artifact represents a downloadable GitHub Actions artifact.

func ListRunArtifacts ¶

func ListRunArtifacts(ctx context.Context, repo string, runID int64) ([]Artifact, error)

ListRunArtifacts retrieves artifacts for a GitHub Actions workflow run.

type Commit ¶

type Commit struct {
	SHA    string        `json:"sha"`
	Commit CommitDetails `json:"commit"`
	Files  []CommitFile  `json:"files"`
}

Commit holds changed-file info fetched from the GitHub API.

func GetCommit ¶

func GetCommit(ctx context.Context, repo, sha string) (Commit, error)

GetCommit fetches commit metadata from the GitHub API. Uses: GET /repos/{owner}/{repo}/commits/{sha}

func (Commit) Filenames ¶

func (c Commit) Filenames() []string

Filenames returns the names of the files changed by the commit.

func (Commit) Title ¶

func (c Commit) Title() string

Title returns the first line of the commit message.

type CommitAuthor ¶

type CommitAuthor struct {
	Name string    `json:"name"`
	Date time.Time `json:"date"`
}

CommitAuthor holds the commit author nested in the GitHub API response.

type CommitDetails ¶

type CommitDetails struct {
	Message string       `json:"message"`
	Author  CommitAuthor `json:"author"`
}

CommitDetails holds the commit metadata nested in the GitHub API response.

type CommitFile ¶

type CommitFile struct {
	Filename string `json:"filename"`
}

CommitFile holds a changed file in the GitHub API response.

type Conclusion ¶

type Conclusion string

Conclusion represents the conclusion status of a workflow run or job.

const (
	ConclusionSuccess Conclusion = "success"
	ConclusionFailure Conclusion = "failure"
)

type Job ¶

type Job struct {
	Name        string     `json:"name"`
	Conclusion  Conclusion `json:"conclusion"`
	Status      string     `json:"status"`
	StartedAt   string     `json:"startedAt"`
	CompletedAt string     `json:"completedAt"`
	URL         string     `json:"url"`
}

Job represents a single job in a GitHub Actions workflow run returned by the gh CLI.

type Run ¶

type Run struct {
	DatabaseID         int64         `json:"databaseId"`
	Number             int           `json:"number"`
	Name               string        `json:"name"`
	WorkflowName       string        `json:"workflowName"`
	WorkflowDatabaseID int64         `json:"workflowDatabaseId"`
	Status             string        `json:"status"`
	Conclusion         Conclusion    `json:"conclusion"`
	HeadBranch         string        `json:"headBranch"`
	HeadSHA            string        `json:"headSha"`
	URL                string        `json:"url"`
	DisplayTitle       string        `json:"displayTitle"`
	Event              string        `json:"event"`
	CreatedAt          time.Time     `json:"createdAt"`
	StartedAt          time.Time     `json:"startedAt"`
	UpdatedAt          time.Time     `json:"updatedAt"`
	Duration           time.Duration `json:"-"`
	Jobs               []Job         `json:"jobs"`
}

Run represents a GitHub Actions workflow run returned by the gh CLI.

func ListRuns ¶

func ListRuns(ctx context.Context, opts RunListOptions) ([]Run, error)

ListRuns retrieves workflow runs through the gh CLI.

func ViewRun ¶

func ViewRun(ctx context.Context, runID string) (Run, error)

ViewRun retrieves workflow run details through the gh CLI.

func (Run) ShortSHA ¶

func (r Run) ShortSHA() string

ShortSHA returns the first seven characters of the run's commit SHA.

type RunDownloadOptions ¶

type RunDownloadOptions struct {
	Repo    string
	Pattern string
	Dir     string
}

RunDownloadOptions configures `gh run download`.

type RunListOptions ¶

type RunListOptions struct {
	Repo       string
	WorkflowID int64
	Branch     string
	Workflow   string
	Event      string
	Status     string
	Created    string
	Limit      int
	All        bool
}

RunListOptions configures workflow-run listing.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL