migrate

package

v0.1.0-alpha.3 Latest Latest Go to latest Published: Oct 25, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Package migrate checks collection format versions and plans the steps that upgrade older files to the current format.

View Source

const CurrentFormat = 1

CurrentFormat is the collection format this version of Flow-I writes.

This section is empty.

func Check(format int) diag.Diagnostic

Check validates a manifest's format number. It returns the zero Diagnostic when the format is supported.

type Step struct {
	From     int
	Describe string
	Apply    func(files map[string][]byte) (map[string][]byte, error)
}

Step upgrades every file of a collection from format From to From+1. Files maps collection-relative paths to contents.

func Plan(from int) ([]Step, error)

Plan returns the steps that move a collection from format `from` to CurrentFormat, in order.

func Steps() []Step

Steps returns every known migration. Format 1 is the first format, so there are none yet.