Documentation
¶
Overview ¶
Package githubactions extracts GitHub Actions workflow dependencies from .github/workflows/*.{yml,yaml} files.
Index ¶
Constants ¶
View Source
const (
// Name is the unique name of this extractor.
Name = "github/actions"
)
Variables ¶
This section is empty.
Functions ¶
func New ¶
func New(cfg *cpb.PluginConfig) (filesystem.Extractor, error)
New returns a GitHub Actions workflow dependency extractor.
For most use cases, initialize with: ``` e := New(&cpb.PluginConfig{}) ```
Types ¶
type Extractor ¶
Extractor extracts GitHub Actions dependencies from workflow files.
func (Extractor) Extract ¶
func (e Extractor) Extract(ctx context.Context, input *filesystem.ScanInput) (inventory.Inventory, error)
Extract extracts GitHub Actions dependencies from a workflow file passed through the scan input.
func (Extractor) FileRequired ¶
func (e Extractor) FileRequired(api filesystem.FileAPI) bool
FileRequired returns true if the file is a GitHub Actions workflow file, i.e. is located directly under a .github/workflows/ directory and has a .yml or .yaml extension.
func (Extractor) Requirements ¶
func (e Extractor) Requirements() *plugin.Capabilities
Requirements of the extractor.
Click to show internal directories.
Click to hide internal directories.