Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
- API
  
  Reference documentation for the pkg.go.dev API
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

github

package

Go to main page

Versions in this module

v0

v0.4.0

Jul 5, 2026

v0.3.1

Jun 20, 2026

v0.3.0

Apr 25, 2026

Changes in this version

+ var ErrOwnerRequired = errors.New("github: owner is required")

+ var ErrRepoRequired = errors.New("github: repo is required")

+ var ErrTokenRequired = errors.New("github: token is required")

+ type Backend struct

+ func New(cfg Config) (*Backend, error)

+ func (b *Backend) Close() error

+ func (b *Backend) Copy(ctx context.Context, src, dst string) error

+ func (b *Backend) Delete(ctx context.Context, filePath string) error

+ func (b *Backend) Exists(ctx context.Context, filePath string) (bool, error)

+ func (b *Backend) Features() omnistorage.Features

+ func (b *Backend) List(ctx context.Context, prefix string) ([]string, error)

+ func (b *Backend) Mkdir(ctx context.Context, filePath string) error

+ func (b *Backend) Move(ctx context.Context, src, dst string) error

+ func (b *Backend) NewBatch(ctx context.Context, message string) (*Batch, error)

+ func (b *Backend) NewReader(ctx context.Context, filePath string, opts ...omnistorage.ReaderOption) (io.ReadCloser, error)

+ func (b *Backend) NewWriter(ctx context.Context, filePath string, opts ...omnistorage.WriterOption) (io.WriteCloser, error)

+ func (b *Backend) Rmdir(ctx context.Context, filePath string) error

+ func (b *Backend) Stat(ctx context.Context, filePath string) (omnistorage.ObjectInfo, error)

+ type Batch struct

+ func (batch *Batch) Commit() error

+ func (batch *Batch) Delete(filePath string) error

+ func (batch *Batch) Len() int

+ func (batch *Batch) Write(filePath string, content []byte) error

+ type BatchOperation struct

+ Content []byte

+ Path string

+ Type BatchOperationType

+ type BatchOperationType int

+ const BatchOpDelete

+ const BatchOpWrite

+ type CommitAuthor struct

+ Email string

+ Name string

+ type Config struct

+ BaseURL string

+ Branch string

+ CommitAuthor *CommitAuthor

+ CommitMessage string

+ Owner string

+ Repo string

+ Token string

+ UploadURL string

+ func ConfigFromEnv() Config

+ func ConfigFromMap(m map[string]string) Config

+ func DefaultConfig() Config

+ func (c *Config) FormatCommitMessage(filePath string) string

+ func (c *Config) Validate() error