semv

package module
v0.0.0-...-0c0fde9 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 13, 2021 License: MIT Imports: 7 Imported by: 0

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

View Source 
const ManifestName = "semv"

ManifestName is the manifest file name used by semver.

View Source 
const ManifestType = "toml"

ManifestType is the manisfest file name format

Variables

This section is empty.

Functions

func SoftwareReleaseCycleLife 

func SoftwareReleaseCycleLife(kind string) []string

SoftwareReleaseCycleLife ...

func WorkingOnPreRelease 

func WorkingOnPreRelease(ctx *Ctx) error

WorkingOnPreRelease ...

Types

type BuildCommand 

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

BuildCommand ..

func (*BuildCommand) Args 

func (cmd *BuildCommand) Args() string

Args ...

func (*BuildCommand) Hidden 

func (cmd *BuildCommand) Hidden() bool

Hidden ...

func (*BuildCommand) LongHelp 

func (cmd *BuildCommand) LongHelp() string

LongHelp ...

func (*BuildCommand) Name 

func (cmd *BuildCommand) Name() string

Name ...

func (*BuildCommand) Register 

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

Register ...

func (*BuildCommand) Run 

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

Run ...

func (*BuildCommand) ShortHelp 

func (cmd *BuildCommand) ShortHelp() string

ShortHelp ...

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 MajorCommand 

type MajorCommand struct {
}

MajorCommand ..

func (*MajorCommand) Args 

func (cmd *MajorCommand) Args() string

Args ...

func (*MajorCommand) Hidden 

func (cmd *MajorCommand) Hidden() bool

Hidden ...

func (*MajorCommand) LongHelp 

func (cmd *MajorCommand) LongHelp() string

LongHelp ...

func (*MajorCommand) Name 

func (cmd *MajorCommand) Name() string

Name ...

func (*MajorCommand) Register 

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

Register ...

func (*MajorCommand) Run 

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

Run ...

func (*MajorCommand) ShortHelp 

func (cmd *MajorCommand) 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 MinorCommand 

type MinorCommand struct {
}

MinorCommand ..

func (*MinorCommand) Args 

func (cmd *MinorCommand) Args() string

Args ...

func (*MinorCommand) Hidden 

func (cmd *MinorCommand) Hidden() bool

Hidden ...

func (*MinorCommand) LongHelp 

func (cmd *MinorCommand) LongHelp() string

LongHelp ...

func (*MinorCommand) Name 

func (cmd *MinorCommand) Name() string

Name ...

func (*MinorCommand) Register 

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

Register ...

func (*MinorCommand) Run 

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

Run ...

func (*MinorCommand) ShortHelp 

func (cmd *MinorCommand) ShortHelp() string

ShortHelp ...

type PatchCommand 

type PatchCommand struct {
}

PatchCommand ..

func (*PatchCommand) Args 

func (cmd *PatchCommand) Args() string

Args ...

func (*PatchCommand) Hidden 

func (cmd *PatchCommand) Hidden() bool

Hidden ...

func (*PatchCommand) LongHelp 

func (cmd *PatchCommand) LongHelp() string

LongHelp ...

func (*PatchCommand) Name 

func (cmd *PatchCommand) Name() string

Name ...

func (*PatchCommand) Register 

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

Register ...

func (*PatchCommand) Run 

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

Run ...

func (*PatchCommand) ShortHelp 

func (cmd *PatchCommand) ShortHelp() string

ShortHelp ...

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 ...

type ReleaseCommand 

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

ReleaseCommand ..

func (*ReleaseCommand) Args 

func (cmd *ReleaseCommand) Args() string

Args ...

func (*ReleaseCommand) Hidden 

func (cmd *ReleaseCommand) Hidden() bool

Hidden ...

func (*ReleaseCommand) LongHelp 

func (cmd *ReleaseCommand) LongHelp() string

LongHelp ...

func (*ReleaseCommand) Name 

func (cmd *ReleaseCommand) Name() string

Name ...

func (*ReleaseCommand) Register 

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

Register ...

func (*ReleaseCommand) Run 

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

Run ...

func (*ReleaseCommand) ShortHelp 

func (cmd *ReleaseCommand) ShortHelp() string

ShortHelp ...

type StatusCommand 

type StatusCommand struct {
}

StatusCommand ..

func (*StatusCommand) Args 

func (cmd *StatusCommand) Args() string

Args ...

func (*StatusCommand) Hidden 

func (cmd *StatusCommand) Hidden() bool

Hidden ...

func (*StatusCommand) LongHelp 

func (cmd *StatusCommand) LongHelp() string

LongHelp ...

func (*StatusCommand) Name 

func (cmd *StatusCommand) Name() string

Name ...

func (*StatusCommand) Register 

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

Register ...

func (*StatusCommand) Run 

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

Run ...

func (*StatusCommand) ShortHelp 

func (cmd *StatusCommand) ShortHelp() string

ShortHelp ...

Source Files

View all Source files

Directories

Path Synopsis
cmd
pm
semv

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.