gha

Documentation

Overview

Package gha provides functionality for working with GitHub Actions.

Index

• Variables
• type GitHubAction
  • func JobActions(repo fs.FS, path, name string) ([]GitHubAction, error)
  • func RepoActions(repo fs.FS) ([]GitHubAction, error)
  • func WorkflowActions(repo fs.FS, path string) ([]GitHubAction, error)

Variables

var WorkflowsPath = path.Join(".github", "workflows")

WorkflowsPath is the relative path to the GitHub Actions workflow directory.

Types

type GitHubAction

type GitHubAction struct {
	// Owner is the GitHub user or organization that owns the repository that
	// houses the GitHub Action.
	Owner string

	// Project is the name of the GitHub repository (excluding the owner) that
	// houses the GitHub Action.
	Project string

	// Ref is the git ref (branch, tag, commit SHA), also known as version, of the
	// GitHub Action.
	Ref string
}

A GitHubAction identifies a specific version of a GitHub Action.

func JobActions

func JobActions(repo fs.FS, path, name string) ([]GitHubAction, error)

JobActions extracts the GitHub Actions used in the specified job in the specified workflow at the given file system hierarchy.

func RepoActions

func RepoActions(repo fs.FS) ([]GitHubAction, error)

RepoActions extracts the GitHub Actions used in the repository at the given file system hierarchy.

func WorkflowActions

func WorkflowActions(repo fs.FS, path string) ([]GitHubAction, error)

WorkflowActions extracts the GitHub Actions used in the specified workflow at the given file system hierarchy.