archiveplugin

Documentation

Index

• Constants
• type ArchiveFile
  • func (a *ArchiveFile) Init() error
• type Request
  • func (r Request) HeartbeatResponse() (Response, bool)
  • func (r *Request) Init() error
• type Response
  • func (r Response) Err() error

Constants

const (
	// Version gets incremented on incompatible changes to the archive plugin or its runtime,
	// think of this as a major version increment in semver terms.
	// This should almost never happen, but if it does, the old archive plugin will probably not work as expected.
	// This will be detected on Hugoreleaser startup and the build will fail.
	// The plugin server then needs to be updated and re-tested.
	Version = 0
)

Types

type ArchiveFile

type ArchiveFile struct {
	// The source filename.
	SourcePathAbs string `toml:"source_path_abs"`

	// Relative target path, including the name of the file.
	TargetPath string `toml:"target_path"`
}

func (*ArchiveFile) Init

func (a *ArchiveFile) Init() error

type Request

type Request struct {
	// Version is the archive plugin version.
	// This is just used for validation on startup.
	Version int `toml:"version"`

	// Heartbeat is a string that is echoed back to the caller,
	// used to test that plugin servers are up and running.
	Heartbeat string `toml:"heartbeat"`

	// BuildInfo holds the basic build information about the current build.
	BuildInfo model.BuildInfo `toml:"build_info"`

	// Settings for the archive.
	// This is the content of archive_settings.custom_settings.
	Settings map[string]any `toml:"settings"`

	Files []ArchiveFile `toml:"files"`

	// Filename with extension.
	OutFilename string `toml:"out_filename"`
}

Request is what is sent to an external archive tool.

func (Request) HeartbeatResponse

func (r Request) HeartbeatResponse() (Response, bool)

HeartbeatResponse returns a Response that, if the second return value is true, will be returned to the caller.

func (*Request) Init

func (r *Request) Init() error

type Response

type Response struct {
	// Heartbeat is a string that is echoed back to the caller,
	// used to test that plugin servers are up and running.
	Heartbeat string `toml:"heartbeat"`

	Error *plugins.Error `toml:"err"`
}

Response is what is sent back from an external archive tool.

func (Response) Err

func (r Response) Err() error