Skip to content

Latest commit

 

History

History
124 lines (85 loc) · 2.49 KB

README.md

File metadata and controls

124 lines (85 loc) · 2.49 KB
Raw

Versioned Files

A tool which updates files in your project with the current version number.

⚠️ CURRENT STATUS ⚠️

This project is in the early development stage. It is currently not functional or useful. Please check back soon.

Example

Given a file README.md which contains:

# Example Project Docs

The current version is `v2.3.16`

And a versioned-files.yml file which contains:

locations:
  - !string-pattern
    file: README.md
    pattern: The current version is `v{{version}}`

Running:

versioned-files update 2.4.1

Will output:

Updating README.md...success

And will update README.md so that:

cat README.md

Will output:

# Example Project Docs

The current version is `v2.4.1`

Getting Help

For help on available commands you can run:

versioned-files help

This will give you all the details you need:

(Non-windows)

A tool which updates files in your project with the current version number.

Usage: versioned-files <COMMAND>

Commands:
  update  Updates the version in all known locations
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

(Windows)

A tool which updates files in your project with the current version number.

Usage: versioned-files.exe <COMMAND>

Commands:
  update  Updates the version in all known locations
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Current Version

To find out what version you are running, you can run:

versioned-files --version
versioned-files 0.4.4

Configuration

When running the update command, a configuration file is required. By default, versioned-files looks for a file named versioned-files.yml in the current directory.

Missing Configuration

If you run versioned-files update without a configuration file present like this:

rm -f versioned-files.yml # TODO extract section into another doc and remove this
versioned-files update 1.2.3

Then you will see the following error:

Error: No versioned-files.yml file found.