putingh

README

putingh (Put in GH)

Put file in the GH

Usage

# Put file in git repository
GH_TOKEN=you_github_token putingh git://owner/repository/branch/name[/name]... localfile

# Put file in git repository release assets
GH_TOKEN=you_github_token putingh asset://owner/repository/release/name localfile

# Put file in gist
GH_TOKEN=you_github_token putingh gist://owner/gist_id/name localfile

# Get file from git repository
GH_TOKEN=you_github_token putingh git://owner/repository/branch/name[/name]...

# Get file from git repository release assets
GH_TOKEN=you_github_token putingh asset://owner/repository/release/name

# Get file from gist
GH_TOKEN=you_github_token putingh gist://owner/gist_id/name

Example

wzshiming/action-upload-release-assets

License

Licensed under the MIT License. See LICENSE for the full license text.

Documentation

Index

• Variables
• type Option
  • func WithContext(ctx context.Context) Option
  • func WithGitAuthorSignature(username, email string) Option
  • func WithGitCommitMessage(fn func(owner, repo, branch, name, path string) string) Option
  • func WithGitCommitOptions(fn func(owner, repo, branch, name, path string) (opt *gogit.CommitOptions)) Option
  • func WithHTTPClient(fun func(cli *http.Client) *http.Client) Option
  • func WithHost(host string) Option
  • func WithOutput(out io.Writer) Option
  • func WithPerPage(perPage int) Option
  • func WithTmpDir(dir string) Option
• type PutInGH
  • func NewPutInGH(token string, options ...Option) *PutInGH
  • func (s *PutInGH) GetFrom(ctx context.Context, uri string) (io.Reader, error)
  • func (s *PutInGH) GetFromGist(ctx context.Context, owner, gistId, name string) (io.Reader, error)
  • func (s *PutInGH) GetFromGit(ctx context.Context, owner, repo, branch, name string) (io.Reader, error)
  • func (s *PutInGH) GetFromReleasesAsset(ctx context.Context, owner, repo, release, name string) (io.Reader, error)
  • func (s *PutInGH) PutIn(ctx context.Context, uri string, r io.Reader) (string, error)
  • func (s *PutInGH) PutInWithFile(ctx context.Context, uri, filename string) (string, error)

Variables

var (
	DefaultOptions = []Option{
		WithHost("https://github.com"),
		WithGitAuthorSignature("bot", ""),
		WithTmpDir("./tmp/"),
		WithOutput(io.Discard),
		WithPerPage(100),
		WithContext(context.Background()),
		WithGitCommitMessage(func(owner, repo, branch, name, path string) string {
			return fmt.Sprintf("Automatic update %s", name)
		}),
	}

	ErrNotFound = fmt.Errorf("not found")
)

Types

type Option

type Option func(p *PutInGH)

func WithContext

func WithContext(ctx context.Context) Option

func WithGitAuthorSignature

func WithGitAuthorSignature(username, email string) Option

func WithGitCommitMessage

func WithGitCommitMessage(fn func(owner, repo, branch, name, path string) string) Option

func WithGitCommitOptions

func WithGitCommitOptions(fn func(owner, repo, branch, name, path string) (opt *gogit.CommitOptions)) Option

func WithHTTPClient

func WithHTTPClient(fun func(cli *http.Client) *http.Client) Option

func WithHost

func WithHost(host string) Option

func WithOutput

func WithOutput(out io.Writer) Option

func WithPerPage

func WithPerPage(perPage int) Option

func WithTmpDir

func WithTmpDir(dir string) Option

type PutInGH

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

func NewPutInGH

func NewPutInGH(token string, options ...Option) *PutInGH

func (*PutInGH) GetFrom

func (s *PutInGH) GetFrom(ctx context.Context, uri string) (io.Reader, error)

func (*PutInGH) GetFromGist

func (s *PutInGH) GetFromGist(ctx context.Context, owner, gistId, name string) (io.Reader, error)

func (*PutInGH) GetFromGit

func (s *PutInGH) GetFromGit(ctx context.Context, owner, repo, branch, name string) (io.Reader, error)

func (*PutInGH) GetFromReleasesAsset

func (s *PutInGH) GetFromReleasesAsset(ctx context.Context, owner, repo, release, name string) (io.Reader, error)

func (*PutInGH) PutIn

func (s *PutInGH) PutIn(ctx context.Context, uri string, r io.Reader) (string, error)

func (*PutInGH) PutInWithFile

func (s *PutInGH) PutInWithFile(ctx context.Context, uri, filename string) (string, error)