Documentation
¶
Overview ¶
Package k6build defines a service for building k8 binaries
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var ErrBuildFailed = errors.New("build failed") //nolint:revive
Functions ¶
Types ¶
type Artifact ¶
type Artifact struct { ID string `json:"id,omitempty"` // URL to fetch the artifact's binary URL string `json:"url,omitempty"` // list of dependencies Dependencies map[string]string `json:"dependencies,omitempty"` // platform Platform string `json:"platform,omitempty"` // binary checksum (sha256) Checksum string `json:"checksum,omitempty"` }
Artifact defines a binary that can be downloaded TODO: add metadata (e.g. list of dependencies, checksum, date compiled)
func (Artifact) PrintSummary ¶ added in v0.3.1
PrintSummary returns a string with a pretty print of the artifact
type BuildService ¶
type BuildService interface { // Build returns a k6 Artifact given its dependencies and version constrain Build(ctx context.Context, platform string, k6Constrains string, deps []Dependency) (Artifact, error) }
BuildService defines the interface of a build service
type Dependency ¶
type Dependency struct { // Name is the name of the dependency. Name string `json:"name,omitempty"` // Constraints contains the version constraints of the dependency. Constraints string `json:"constraints,omitempty"` }
Dependency contains the properties of a k6 dependency.
Directories
¶
Path | Synopsis |
---|---|
Package cmd contains build cobra command factory function.
|
Package cmd contains build cobra command factory function. |
cache
Package cache implements the cache command
|
Package cache implements the cache command |
k6build
package main implements the CLI root command for the k6build tool
|
package main implements the CLI root command for the k6build tool |
local
Package local implements the local build command
|
Package local implements the local build command |
remote
Package remote implements the client command
|
Package remote implements the client command |
server
Package server implements the build server command
|
Package server implements the build server command |
pkg
|
|
api
Package api defines the interface to a build service
|
Package api defines the interface to a build service |
cache
Package cache defines the interface of a cache service
|
Package cache defines the interface of a cache service |
cache/api
Package api defines the interface to a cache server
|
Package api defines the interface to a cache server |
cache/client
Package client implements a cache client
|
Package client implements a cache client |
cache/file
Package file implements a file-backed cache
|
Package file implements a file-backed cache |
cache/server
Package server implements a cache server
|
Package server implements a cache server |
client
Package client implements a client for a build service
|
Package client implements a client for a build service |
local
Package local implements a local build service
|
Package local implements a local build service |
server
Package server implements a build server
|
Package server implements a build server |
tools
|
|
gendoc
Package main contains CLI documentation generator tool.
|
Package main contains CLI documentation generator tool. |
Click to show internal directories.
Click to hide internal directories.