contract

package

v0.1.0 Latest Latest Go to latest Published: Jun 10, 2026 License: MIT Imports: 0 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/DavidArthurCole/synckit

Links

Open Source Insights

Documentation ¶

Overview ¶

Package contract holds the stable JSON types shared across the synckit HTTP surface — between the bot, the deploy-agent, and any non-Go consumer (the .NET app, the device farm). Field tags are frozen; changing them breaks wire compatibility with existing consumers.

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type DeployResponse ¶

type DeployResponse struct {
	OK              bool   `json:"ok"`
	AlreadyUpToDate bool   `json:"alreadyUpToDate,omitempty"`
	Tail            string `json:"tail,omitempty"`
	FromHash        string `json:"fromHash,omitempty"`
	ToHash          string `json:"toHash,omitempty"`
}

DeployResponse is what the deploy-agent returns to the bot after a pipeline run.

type NewVersionEvent ¶

type NewVersionEvent struct {
	Package    string `json:"package"`
	Version    string `json:"version"`
	APKRef     string `json:"apkRef"`
	ProtoSHA   string `json:"protoSha"`
	DetectedAt string `json:"detectedAt"`
}

NewVersionEvent is posted by the device farm to a sync server when a new game version (and proto) is detected.

type VerifyInfo ¶

type VerifyInfo struct {
	Name    string `json:"name"`
	SHA256  string `json:"sha256"`
	Version string `json:"version"`
	Date    string `json:"date"`
}

VerifyInfo is a server's build identity, surfaced by the /verify bot command.

Source Files ¶

View all Source files

contract.go

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