cli

package

v0.0.0-...-fb79b61 Latest Latest Go to latest Published: Jun 1, 2024 License: MIT Imports: 31 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/pentops/jsonapi

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func CommandSet() *commander.CommandSet
func RunImage(ctx context.Context, cfg BuildConfig) error
func RunJDef(ctx context.Context, cfg BuildConfig) error
func RunSwagger(ctx context.Context, cfg BuildConfig) error
type BuildConfig
type DiscardFS
- func NewDiscardFS() *DiscardFS
- func (d *DiscardFS) Put(ctx context.Context, subPath string, body io.Reader) error
type LocalFS
- func NewLocalFS(root string) (*LocalFS, error)
- func (local *LocalFS) Put(ctx context.Context, subPath string, body io.Reader) error
type SourceConfig
- func (cfg SourceConfig) GetSource(ctx context.Context) (builder.Source, error)

Constants ¶

This section is empty.

Variables ¶

View Source

var Commit = func() string {
	if info, ok := debug.ReadBuildInfo(); ok {
		for _, setting := range info.Settings {
			if setting.Key == "vcs.revision" {
				return setting.Value
			}
		}
	}
	return "dev"
}()

Functions ¶

func CommandSet ¶

func CommandSet() *commander.CommandSet

func RunImage ¶

func RunImage(ctx context.Context, cfg BuildConfig) error

func RunJDef ¶

func RunJDef(ctx context.Context, cfg BuildConfig) error

func RunSwagger ¶

func RunSwagger(ctx context.Context, cfg BuildConfig) error

Types ¶

type BuildConfig ¶

type BuildConfig struct {
	Source string `flag:"src" default:"." description:"Source directory containing jsonapi.yaml and buf.lock.yaml"`
	Output string `flag:"output" default:"-" description:"Destination to push image to. - for stdout, s3://bucket/prefix, otherwise a file"`
}

type DiscardFS ¶

type DiscardFS struct{}

func NewDiscardFS ¶

func NewDiscardFS() *DiscardFS

func (*DiscardFS) Put ¶

func (d *DiscardFS) Put(ctx context.Context, subPath string, body io.Reader) error

type LocalFS ¶

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

func NewLocalFS ¶

func NewLocalFS(root string) (*LocalFS, error)

func (*LocalFS) Put ¶

func (local *LocalFS) Put(ctx context.Context, subPath string, body io.Reader) error

type SourceConfig ¶

type SourceConfig struct {
	Source        string   `flag:"src" default:"." description:"Source directory containing j5.yaml and buf.lock.yaml"`
	CommitHash    string   `flag:"commit-hash" env:"COMMIT_HASH" default:""`
	CommitTime    string   `flag:"commit-time" env:"COMMIT_TIME" default:""`
	CommitAliases []string `flag:"commit-alias" env:"COMMIT_ALIAS" default:""`

	GitAuto bool `flag:"git-auto" env:"COMMIT_INFO_GIT_AUTO" default:"false" description:"Automatically pull commit info from git"`
}

func (SourceConfig) GetSource ¶

func (cfg SourceConfig) GetSource(ctx context.Context) (builder.Source, error)

Source Files ¶

View all Source files

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