orzo.core — luchiniatwork/orzo 0.1.11

append clj

(append version value)

Appends the value to the version in the pipe.

bump-semver clj

(bump-semver version indicator)

Bumps the specific indicator of an incoming semver. Options for indicator are :major, :minor, and :patch.

Bumps do ripple through lower order indicators (i.e. 0.1.5 with a :minor bump would lead to 0.2.0)

calver clj

(calver)

(calver one-arg)

(calver date format-str)

Returns a calver (https://calver.org) based on LocalDate and following the format specified in format-str:

• YYYY - Full year - 2006, 2016, 2106
• YY - Short year - 6, 16, 106
• 0Y - Zero-padded year - 06, 16, 106
• MM - Short month - 1, 2 ... 11, 12
• 0M - Zero-padded month - 01, 02 ... 11, 12
• WW - Short week (since start of year) - 1, 2, 33, 52
• 0W - Zero-padded week - 01, 02, 33, 52
• DD - Short day - 1, 2 ... 30, 31
• 0D - Zero-padded day - 01, 02 ... 30, 31

Uses the ISO-8601 definition, where a week starts on Monday and the first week has a minimum of 4 days.

The default format string is YYYY.0M.0D.

Calling this function without args uses now LocalDate and the default format.

Calling this function with one arg the arg can be either a LocalDate object or a string format.

env clj

(env var-name)

Returns the value of the environment variable.

extract-base-semver clj

(extract-base-semver version)

Parses the incoming version as a pure semver (just a simple string of <major>.<minor>.<patch>).

instant clj

(instant)

Returns a timestamp as a string.

prepend clj

(prepend version value)

Prepends the value to the version in the pipe.

read-file clj

(read-file path)

(read-file path regex)

Reads a version (or any other information) from a file. If a path is provided, the first line of the file should contain the information you are want to read.

If a path and a regex is provided, the whole file is read and the first group match of the regex is returned. If no match is found, an exception is thrown.

save-file clj

(save-file version path)

(save-file version path template-path)

(save-file version path template-path var-name)

Saves the incoming version from the pipeline to the file specified by the path.

A template file can be specified as the third parameter. In such case, the string ${VERSION} will be replaced with the incoming version.

It is also possible to specify a placeholder name in case your template has a different format (i.e. you could specify "SEMVER" to have all the ${SEMVER} replaced.

set-semver clj

(set-semver version {:keys [major minor patch ripple?] :as opts})

Allows direct manipulation of an incoming semver version.

The second parameter is a map with the keys:

• major: major number to set the semver
• minor: minor number to set the semver
• patch: patch number to set the semver
• ripple?: (default false) if true, then any change on higher order indicator ripple through the lower order ones (i.e. change a major up would set minor and patch to 0 each)

If a certain key is not passed, then that indicator is untouched.

If the incoming version is not parsed as a semver, extract-base-semver will be called on it.

stage clj

(stage version)

Stages the incoming version so that it can be used later.

unstage clj

(unstage)

Unstages a version that had been previously stage by the stage function.