Liking cljdoc? Tell your friends :D
Clojure only.

automaton-build.os.version

Version of the current codebase

  • Version is based on a root project file named version.edn. Strengths:
  • One source of truth for version.
  • Change of version in a PR is more straightforward to notice
  • Flexibility (We don't decide on versioning strategy, we just have file that is point of reference to what version you are on.) Constraints:
  • Keeping up with updates for version files (although with automated tooling we have, it is not that big of a deal currently)

Previous design:

  • major version has to be changed in the major-version in build_config.edn (many sources of truth and build_config shouldn't be a place that is used as variable that change often)
  • counting commits from a branch to base a minor version on it (Many edgecases where commits don't match the version, initial commits, PRs having more than one commit...)
Version of the current codebase

* Version is based on a root project file named `version.edn`.
Strengths:
* One source of truth for version.
* Change of version in a PR is more straightforward to notice
* Flexibility (We don't decide on versioning strategy, we just have file that is point of reference to what version you are on.)
Constraints:
 * Keeping up with updates for version files (although with automated tooling we have, it is not that big of a deal currently)

Previous design:
* major version has to be changed in the major-version in `build_config.edn` (many sources of truth and build_config shouldn't be a place that is used as variable that change often)
* counting commits from a branch to base a minor version on it (Many edgecases where commits don't match the version, initial commits, PRs having more than one commit...)
raw docstring

add-optional-qualifierclj

(add-optional-qualifier version qualifier)

ask-manual-versionclj

(ask-manual-version)

Asks user to input version manually

Asks user to input version manually
raw docstring

ask-versionclj

(ask-version project-name current-version)
(ask-version project-name current-version changes)

Asks user what should be a new version following the non-breaking version system

Asks user what should be a new version following the non-breaking version system
raw docstring

current-versionclj

(current-version app-dir)

generate-new-versionclj

(generate-new-version current-version app-name changes)

save-versionclj

(save-version app-dir new-version)

Update app version file version.edn in app-dir. Captures requirement for the version to be consciously decided when saved Params:

  • app-dir directory of the version to count
  • new-version
Update app version file `version.edn` in `app-dir`. Captures requirement for the version to be consciously decided when saved
Params:
* `app-dir` directory of the version to count
* `new-version`
raw docstring

split-optional-qualifierclj

(split-optional-qualifier version)

Removes optional qualifier. (Semantic versioning: <major>.<minor>.<non-breaking>[-optional-qualifier]) So e.g. 0.0.20-SNAPSHOT -> 0.0.20

Removes optional qualifier. (Semantic versioning: <major>.<minor>.<non-breaking>[-optional-qualifier])
So e.g. `0.0.20-SNAPSHOT` -> `0.0.20`
raw docstring

version-fileclj

(version-file)
(version-file dir)

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcutsReport a problemcljdoc on GitHub
× close