Help us shape the future of Go! Take the 2026 Go Developer Survey

github

package
v1.233.0 Latest Latest
Warning

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

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

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewStore

func NewStore(opts artifact.StoreOptions) (artifact.Backend, error)

NewStore creates a new GitHub Artifacts backend.

Types

type Store

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

Store implements the artifact.Backend interface using GitHub Actions Artifacts.

func (*Store) Delete

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

Delete deletes an artifact.

func (*Store) Download

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

Download downloads an artifact and extracts the tar stream from the zip.

func (*Store) Exists

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

Exists checks if an artifact exists.

func (*Store) GetMetadata

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

GetMetadata retrieves metadata for an artifact.

func (*Store) List

func (s *Store) List(ctx context.Context, query artifact.Query) ([]artifact.ArtifactInfo, error)

List lists artifacts matching the given query.

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, size int64, metadata *artifact.Metadata) error

Upload uploads a single data stream as a GitHub artifact. Creates a zip containing archive.tar (the data stream) + metadata.json. This requires running within GitHub Actions with ACTIONS_RUNTIME_TOKEN and ACTIONS_RESULTS_URL environment variables set. GitHub withholds those from `run:` steps, so surface them with the actions/github-runtime helper action when invoking Atmos from a shell step.

Jump to

Keyboard shortcuts

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