changefile

package

v0.0.0-...-93b3838 Latest Latest Go to latest Published: May 31, 2020 License: GPL-3.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

git.sr.ht/~tonymottaz/pin

Documentation ¶

Overview ¶

Package changefile provides functions for creating and modifying Changefiles within a project.

Index ¶

func Create(change *Change, projectRoot string) (string, error)
func CreatePinDirectory(projectRoot string) (string, error)
type Change

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Create ¶

func Create(change *Change, projectRoot string) (string, error)

Create writes change data to a new Changefile at <projectRoot>/.pin/<timestamp>.chg. Returns the completed filepath to the new Changefile.

func CreatePinDirectory ¶

func CreatePinDirectory(projectRoot string) (string, error)

CreatePinDirectory will create the directory <projectRoot>/.pin if it does not already exist. projectRoot can be an absolute or a relative path to the parent directory of .pin. Returns the path to the Pin directory.

Types ¶

type Change ¶

type Change struct {
	Summary string `toml:"summary" json:"summary" yaml:"summary"`
}

Change represents the data in a changefile.

Source Files ¶

View all Source files

changefile.go

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