pm

README

Semantic Versioning

semv It is a tool that facilitates the manipulation of the semantic-versioning of a software project. Upon initialization, it generates a semv.toml file that contains the semantic-versioning data.

Our goals

• semv.toml be a standard file that stores the software semantic-versioning
• Facilitate the manipulation of semantic-versioning regardless of the software project
• Based on spec semver.org

Use badge

# HEADER:  Copy and replace VERSION for current version 
[![](https://img.shields.io/badge/semv-VERSION-green)](semv.toml)

[![](https://img.shields.io/badge/semver.org-by semv-green)](https://github.com/josehbez/semv)

Download and install

if you're interested in getting the source code, or hacking on semv, you can intall via go get.

go get -u github.com/josehbez/semv

If you're interested use mode production

go install github.com/josehbez/semv/cmd/semv

Documentation

Index

• Constants
• type Ctx
• type InitCommand
  • func (cmd *InitCommand) Args() string
  • func (cmd *InitCommand) Hidden() bool
  • func (cmd *InitCommand) LongHelp() string
  • func (cmd *InitCommand) Name() string
  • func (cmd *InitCommand) Register(fs *flag.FlagSet)
  • func (cmd *InitCommand) Run(ctx *Ctx, args []string) error
  • func (cmd *InitCommand) ShortHelp() string
• type Manifest
  • func NewManifest() *Manifest
  • func (m Manifest) DefaultVersion() error
  • func (m *Manifest) ValidateManifest() error
• type RawBuild
• type RawManifest
• type RawRelease
• type RawVersion

Constants

const ManifestName = ".pm"

ManifestName is the manifest file name used by semver.

const ManifestType = "toml"

ManifestType is the manisfest file name format

Types

type Ctx

type Ctx struct {
	WorkingDir string // Where to execute.
	Manifest   *Manifest
	Out, Err   *log.Logger // Required loggers.

}

Ctx ...

type InitCommand

type InitCommand struct {
}

InitCommand ..

func (*InitCommand) Args

func (cmd *InitCommand) Args() string

Args ...

func (*InitCommand) Hidden

func (cmd *InitCommand) Hidden() bool

Hidden ...

func (*InitCommand) LongHelp

func (cmd *InitCommand) LongHelp() string

LongHelp ...

func (*InitCommand) Name

func (cmd *InitCommand) Name() string

Name ...

func (*InitCommand) Register

func (cmd *InitCommand) Register(fs *flag.FlagSet)

Register ...

func (*InitCommand) Run

func (cmd *InitCommand) Run(ctx *Ctx, args []string) error

Run ...

func (*InitCommand) ShortHelp

func (cmd *InitCommand) ShortHelp() string

ShortHelp ...

type Manifest

type Manifest struct {
	Name  string
	Viper *viper.Viper
}

Manifest holds manifest file data

func NewManifest

func NewManifest() *Manifest

NewManifest ..

func (Manifest) DefaultVersion

func (m Manifest) DefaultVersion() error

DefaultVersion ...

func (*Manifest) ValidateManifest

func (m *Manifest) ValidateManifest() error

ValidateManifest ...

type RawBuild

type RawBuild struct {
	RawVersion
}

RawBuild ...

type RawManifest

type RawManifest struct {
	Version RawVersion `mapstructure:"version"`
	Release RawRelease `mapstructure:"release"`
	Build   RawBuild   `mapstructure:"build"`
}

RawManifest ...

type RawRelease

type RawRelease struct {
	RawVersion
}

RawRelease ...

type RawVersion

type RawVersion struct {
	Major int    `mapstructure:"major"`
	Minor int    `mapstructure:"minor"`
	Patch int    `mapstructure:"patch"`
	Label string `mapstructure:"label"`
}

RawVersion ...