github

package
v1.208.0-test.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 20, 2026 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewStore

func NewStore(opts planfile.StoreOptions) (planfile.Store, error)

NewStore creates a new GitHub Artifacts store.

Types

type Store

type Store struct {
	// contains filtered or unexported fields
}

Store implements the planfile.Store interface using GitHub Actions Artifacts.

func (*Store) Delete

func (s *Store) Delete(ctx context.Context, key string) error

Delete deletes a planfile artifact.

func (*Store) Download

func (s *Store) Download(ctx context.Context, key string) (io.ReadCloser, *planfile.Metadata, error)

Download downloads a planfile from GitHub artifacts.

func (*Store) Exists

func (s *Store) Exists(ctx context.Context, key string) (bool, error)

Exists checks if a planfile artifact exists.

func (*Store) GetMetadata

func (s *Store) GetMetadata(ctx context.Context, key string) (*planfile.Metadata, error)

GetMetadata retrieves metadata for a planfile artifact.

func (*Store) List

func (s *Store) List(ctx context.Context, prefix string) ([]planfile.PlanfileInfo, error)

List lists planfile artifacts.

func (*Store) Name

func (s *Store) Name() string

Name returns the store type name.

func (*Store) Upload

func (s *Store) Upload(ctx context.Context, key string, data io.Reader, metadata *planfile.Metadata) error

Upload uploads a planfile as a GitHub artifact. Note: GitHub Actions artifacts must be uploaded using the @actions/artifact toolkit within a workflow. This implementation provides the interface but may require shell-out to the actions toolkit for actual uploads.

Jump to

Keyboard shortcuts

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