Skip to content

Latest commit

 

History

History
115 lines (83 loc) · 2.37 KB

README.md

File metadata and controls

115 lines (83 loc) · 2.37 KB
Raw

揚炮 yangpao v0.1.1 n101

Circle CI

version number bumper for semver

inspired by bmp

synopsis

  • bumps version numbers in your project files in keeping with a setting file
    • major version
    • minor version
    • patch version

requirements

  • yangpao dose not need any requirements.

install

release page

  1. get an executable
    • binary download
      • Get a newest binary for your os/arch from release page.
      • Rename it to yangpao.
      • Put your yangpao into a directory within your $PATH.
    • go get
      • go get github.com/januswel/yangpao
  2. generate a setting file
    • Change the directory to your project root
    • Run yangpao -g

usage

.yangpao.toml

Edit your .yangpao.toml

Current = "2.1.3"

[[Files]]
  # matches like "2.1.3" in README.md
  Path = "README.md"
  Prefix = ""
  Postfix = ""

[[Files]]
  # matches like "ver2.1.3" in release_tag
  Path = "release_tag"
  Prefix = "ver"
  Postfix = ""

[[Files]]
  # matches like "ver 2.1.3" in version.txt
  Path = "assets/version.txt"
  Prefix = "ver "
  Postfix = ""

[[Files]]
  # matches like "yangpao 2.1.3 version" in src/public/index.html
  Path = "src/public/index.html"
  Prefix = "yangpao "
  Postfix = " version"

[[Files]]
  # matches like android:versionCode="20103" in AndroidManifest.xml
  Path = "AndroidManifest.xml"
  Prefix = "android:versionCode=\""
  Postfix = "\""
  IsNumber = true

IsNumber

If "IsNumber" field is true, its "Files" settings are matches and bumps with sequential version number which corresponds to major * 10000 + minor * 100 + patch.

yangpao

# shows current version and checks consistency
yangpao

# shows current version only
yangpao --current
yangpao -c

# generates setting file on current directory
yangpao --generate
yangpao -g

# bumps patch version number
yangpao --patch
yangpao -p

# bumps minor version number
yangpao --minor
yangpao -m

# bumps major version number
# short option is not provided to prevent operational erros
# because this operation means the version upgrade includes incompatible changes
yangpao --major