repo

Documentation

Index

• Constants
• func IsValidVersion(version int) bool
• type FsRepo
  • func NewFS(params FsRepoParams) (*FsRepo, error)
  • func (fsr *FsRepo) Exists() (bool, error)
  • func (fsr *FsRepo) Init() error
  • func (fsr *FsRepo) Open() error
  • func (fsr *FsRepo) Path() (string, error)
  • func (fsr *FsRepo) Version() (int, error)
  • func (fsr *FsRepo) WriteRunInfo(ctx context.Context, summaryShellVariablesString string) (string, error)
• type FsRepoParams
• type Migration
  • func NewMigration(fromVersion, toVersion int, migrations ...MigrationFn) Migration
  • func (m Migration) Migrate(repo FsRepo) error
• type MigrationFn
• type MigrationManager
  • func NewMigrationManager(migrations ...Migration) (*MigrationManager, error)
  • func (m *MigrationManager) Add(migration Migration) error
  • func (m *MigrationManager) Migrate(repo FsRepo) error
• type RepoVersion

Constants

const (
	// RepoVersion3 is the current repo versioning.
	RepoVersion3 = 3
	// RepoVersion2 is the repo versioning up to v1.2.1
	RepoVersion2 = 2
	// RepoVersion1 is the repo versioning for v1-v1.1.4
	RepoVersion1 = 1
	// RepoVersionFile is the name of the repo file containing the repo version.
	RepoVersionFile = "repo.version"
)

const (

	// UpdateCheckStatePath is the update check paths.
	UpdateCheckStatePath = "update.json"
)

Functions

func IsValidVersion

func IsValidVersion(version int) bool

IsValidVersion returns true if the version is valid.

Types

type FsRepo

type FsRepo struct {
	Migrations *MigrationManager
	// contains filtered or unexported fields
}

func NewFS

func NewFS(params FsRepoParams) (*FsRepo, error)

func (*FsRepo) Exists

func (fsr *FsRepo) Exists() (bool, error)

func (*FsRepo) Init

func (fsr *FsRepo) Init() error

func (*FsRepo) Open

func (fsr *FsRepo) Open() error

func (*FsRepo) Path

func (fsr *FsRepo) Path() (string, error)

func (*FsRepo) Version

func (fsr *FsRepo) Version() (int, error)

Version returns the version of the repo.

func (*FsRepo) WriteRunInfo

func (fsr *FsRepo) WriteRunInfo(ctx context.Context, summaryShellVariablesString string) (string, error)

type FsRepoParams

type FsRepoParams struct {
	Path       string
	Migrations *MigrationManager
}

type Migration

type Migration struct {
	FromVersion int
	ToVersion   int
	Migrations  []MigrationFn
}

func NewMigration

func NewMigration(fromVersion, toVersion int, migrations ...MigrationFn) Migration

NewMigration creates a new migration.

func (Migration) Migrate

func (m Migration) Migrate(repo FsRepo) error

Migrate runs the migrations on the given repo.

type MigrationFn

type MigrationFn = func(FsRepo) error

type MigrationManager

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

func NewMigrationManager

func NewMigrationManager(migrations ...Migration) (*MigrationManager, error)

NewMigrationManager creates a new migration manager.

func (*MigrationManager) Add

func (m *MigrationManager) Add(migration Migration) error

Add adds a migration to the manager.

func (*MigrationManager) Migrate

func (m *MigrationManager) Migrate(repo FsRepo) error

Migrate runs the migrations on the given repo.

type RepoVersion

type RepoVersion struct {
	Version int
}