From d3d0070a2ee8db4ab802f108b5dcf03024b480f6 Mon Sep 17 00:00:00 2001 From: alansemenov Date: Thu, 18 Jan 2024 13:26:14 +0100 Subject: [PATCH] Moved xp_version to a separate file --- INSTALL.md | 2 +- docs/install.adoc | 2 +- docs/usage.adoc | 3 ++- docs/variables.adoc | 1 + 4 files changed, 5 insertions(+), 3 deletions(-) create mode 100644 docs/variables.adoc diff --git a/INSTALL.md b/INSTALL.md index 074c33bf..edc2ed07 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -54,7 +54,7 @@ For other OSes, please see [Goreleaser](https://goreleaser.com). ## Releasing a new version 1. Ensure [release notes](docs%2Freleases.adoc) are updated (for a feature release) -1. Change value of `:xp_version:` variable in the [installation guide](docs%2Finstall.adoc) to `X.Y.Z` (version of the upcoming release) +1. Change value of `:xp_version:` variable in the [variables file](docs%2variables.adoc) to `X.Y.Z` (version of the upcoming release) 1. Commit all the uncommitted changes. Make sure HEAD is not in dirty state (no uncommitted changes). 1. Run `git tag vX.Y.Z` 1. Run `git push origin vX.Y.Z` to trigger the release via Github actions. diff --git a/docs/install.adoc b/docs/install.adoc index 10341210..ff983b5b 100644 --- a/docs/install.adoc +++ b/docs/install.adoc @@ -1,4 +1,4 @@ -:xp_version: 2.6.0 +include::variables.adoc[] = Install, upgrade or uninstall Enonic CLI diff --git a/docs/usage.adoc b/docs/usage.adoc index 581d7881..cddc48cd 100644 --- a/docs/usage.adoc +++ b/docs/usage.adoc @@ -1,3 +1,4 @@ +include::variables.adoc[] = Getting started with Enonic CLI Once installed, the CLI includes standard CLI help functions for listing available commands and options. @@ -8,7 +9,7 @@ To get a list of commands, simply type the following in your terminal: The feedback will contain available commands and options: ---- -Enonic CLI v.2.7.0 +Enonic CLI v{xp_version} Manage XP instances, home folders and projects USAGE: diff --git a/docs/variables.adoc b/docs/variables.adoc new file mode 100644 index 00000000..eb6ed47e --- /dev/null +++ b/docs/variables.adoc @@ -0,0 +1 @@ +:xp_version: 2.8.0