changeset

package

v0.1.1 Latest Latest Go to latest Published: Jan 28, 2026 License: MIT Imports: 12 Imported by: 0

Details

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

Repository

github.com/gojekfarm/xtools

Links

Open Source Insights

Documentation ¶

Overview ¶

Package changeset provides core types and operations for managing changesets.

Index ¶

Variables
func ChangesetDirExists(dir string) bool
func DeleteChangeset(cs *Changeset) error
func DeleteManifest(dir string) error
func GenerateID() string
func IncrementVersion(current string, bump Bump) (string, error)
func InitChangeset(dir string, cfg *Config) error
func ManifestExists(dir string) bool
func WriteChangeset(dir string, cs *Changeset) error
func WriteConfig(dir string, cfg *Config) error
func WriteManifest(dir string, m *Manifest) error
type Bump
- func (a Bump) Compare(b Bump) int
- func (a Bump) String() string
type Changeset
- func ParseChangeset(path string) (*Changeset, error)
- func ReadChangesets(dir string) ([]*Changeset, error)
type Config
- func DefaultConfig() *Config
- func ReadConfig(dir string) (*Config, error)
type Manifest
- func ReadManifest(dir string) (*Manifest, error)
type Release
- func ComputeReleases(changesets []*Changeset, graph *module.Graph, tags map[string]string, ...) ([]Release, error)
- func FilterIgnored(releases []Release, ignore []string) []Release

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrNoChangesets     = errors.New("no changesets found")
	ErrNoManifest       = errors.New("release manifest not found")
	ErrInvalidChangeset = errors.New("invalid changeset format")
	ErrInvalidVersion   = errors.New("invalid semantic version")
	ErrUncommitted      = errors.New("uncommitted changes exist")
)

Sentinel errors for changeset operations.

Functions ¶

func ChangesetDirExists ¶

func ChangesetDirExists(dir string) bool

ChangesetDirExists returns true if the .changeset directory exists.

func DeleteChangeset ¶

func DeleteChangeset(cs *Changeset) error

DeleteChangeset removes a changeset file.

func DeleteManifest ¶

func DeleteManifest(dir string) error

DeleteManifest removes .changeset/release-manifest.json.

func GenerateID ¶

func GenerateID() string

GenerateID returns a random changeset ID (e.g., "hungry-tiger-jump").

func IncrementVersion ¶

func IncrementVersion(current string, bump Bump) (string, error)

IncrementVersion bumps a semantic version by the given bump type.

func InitChangeset ¶

func InitChangeset(dir string, cfg *Config) error

InitChangeset creates the .changeset directory with config and README.

func ManifestExists ¶

func ManifestExists(dir string) bool

ManifestExists returns true if release-manifest.json exists.

func WriteChangeset ¶

func WriteChangeset(dir string, cs *Changeset) error

WriteChangeset writes a changeset to the .changeset directory. Generates a random ID if cs.ID is empty.

func WriteConfig ¶

func WriteConfig(dir string, cfg *Config) error

WriteConfig writes config to .changeset/config.json.

func WriteManifest ¶

func WriteManifest(dir string, m *Manifest) error

WriteManifest writes the manifest to .changeset/release-manifest.json.

Types ¶

type Bump ¶

type Bump string

Bump represents a semantic version bump type.

const (
	BumpPatch Bump = "patch"
	BumpMinor Bump = "minor"
	BumpMajor Bump = "major"
)

func (Bump) Compare ¶

func (a Bump) Compare(b Bump) int

Compare returns:

-1 if a < b
 0 if a == b
 1 if a > b

Ordering: patch < minor < major

func (Bump) String ¶

func (a Bump) String() string

String returns the string representation of the bump.

type Changeset ¶

type Changeset struct {
	ID       string          // Filename without extension (e.g., "hungry-tiger-jump")
	Modules  map[string]Bump // Module short name -> bump type
	Summary  string          // Markdown description
	FilePath string          // Full path to the file
}

Changeset represents a single changeset file.

func ParseChangeset ¶

func ParseChangeset(path string) (*Changeset, error)

ParseChangeset reads and parses a single changeset file. Returns error if file format is invalid.

func ReadChangesets ¶

func ReadChangesets(dir string) ([]*Changeset, error)

ReadChangesets reads all changeset files from the .changeset directory. Skips config.json, README.md, and release-manifest.json.

type Config ¶

type Config struct {
	Root          string   `json:"root"`          // Root module path
	BaseBranch    string   `json:"baseBranch"`    // Default: "main"
	Ignore        []string `json:"ignore"`        // Modules to ignore
	IgnorePaths   []string `json:"ignorePaths"`   // File paths to ignore in CI check
	DependentBump Bump     `json:"dependentBump"` // How to bump dependents (default: "patch")
}

Config represents .changeset/config.json.

func DefaultConfig ¶

func DefaultConfig() *Config

DefaultConfig returns a Config with sensible defaults.

func ReadConfig ¶

func ReadConfig(dir string) (*Config, error)

ReadConfig reads .changeset/config.json. Returns DefaultConfig if file doesn't exist.

type Manifest ¶

type Manifest struct {
	Releases []Release `json:"releases"`
}

Manifest represents .changeset/release-manifest.json.

func ReadManifest ¶

func ReadManifest(dir string) (*Manifest, error)

ReadManifest reads .changeset/release-manifest.json. Returns error if file doesn't exist.

type Release ¶

type Release struct {
	Module          string `json:"module"`
	Version         string `json:"version"`
	PreviousVersion string `json:"previousVersion"`
	Bump            Bump   `json:"bump"`
	Reason          string `json:"reason,omitempty"` // "dependency" if auto-bumped
}

Release represents a computed release for a module.

func ComputeReleases ¶

func ComputeReleases(
	changesets []*Changeset,
	graph *module.Graph,
	tags map[string]string,
	cfg *Config,
) ([]Release, error)

ComputeReleases calculates version bumps from changesets.

Algorithm:

Aggregate bumps per module (highest bump wins)
Get current versions from git tags
Cascade bumps to dependent modules
Compute next versions

Parameters:

changesets: All pending changesets
graph: Module dependency graph
tags: Current git tags (module short name -> version)
cfg: Config for dependent bump behavior

Returns releases sorted by module name.

func FilterIgnored ¶

func FilterIgnored(releases []Release, ignore []string) []Release

FilterIgnored removes ignored modules from the releases list.

Source Files ¶

View all Source files

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