Skip to content

Commit

Permalink
Release notes for 3.0 #532
Browse files Browse the repository at this point in the history
  • Loading branch information
@alansemenov
alansemenov committed Apr 15, 2024
1 parent 1cb51dc commit 46ab768
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 59 deletions.
8 changes: 4 additions & 4 deletions docs/dev.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Options:
--repository`
|repository path of the starter to base the project on. Format: <enonic repo> or <organisation>/<repo> on github or <full repo url>

|`-s, --sb, --sandbox`
|`-s, --sandbox`
|sandbox name to link project to

|`--prod`
Expand Down Expand Up @@ -51,7 +51,7 @@ If you need to automate this command completely for pipeline integration, you ca

.Example creating a project called 'foo' non-interactively in a new folder with the same name ('foo') using the Vanilla starter and existing sandbox called 'Sandbox1', with default version number ('1.0.0-SNAPSHOT'):
----
$ enonic create foo -f -r starter-vanilla --sb Sandbox1
$ enonic create foo -f -r starter-vanilla -s Sandbox1
----

== Dev
Expand Down Expand Up @@ -111,7 +111,7 @@ OPTIONS:

Navigate to the folder you wish to place your project in and run the following command:

$ enonic project create [name] [-n <value>] [-b <value>] [-c <value>] [-d <value>] [-r <value>] [-v <value>] [--sb <value>]
$ enonic project create [name] [-n <value>] [-b <value>] [-c <value>] [-d <value>] [-r <value>] [-v <value>] [-s <value>]

Follow wizard instructions that will set everything up for you.

Expand Down Expand Up @@ -144,7 +144,7 @@ Options:
|`-v, --ver, --version`
|version number to assign to new project. Default value `1.0.0-SNAPSHOT`

|`-s, --sb, --sandbox`
|`-s, --sandbox`
|sandbox name to link project to

|`--prod`
Expand Down
92 changes: 38 additions & 54 deletions docs/releases.adoc
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,28 @@
= Release notes

== v2.8.0
== CLI 3

=== Features

* `sandbox start` starts sandbox in dev mode by default
* `project test` command to execute `gradle test` task for a project
* `sandbox copy` command for copying an existing sandbox
* `threshold` option for the `vacuum` command for specifying age of data to be removed
* `clean` option for the `snapshot restore` command to delete indices before restoring

=== Improvements

* Suggest starting a new sandbox after it's created
* Support short `-s` flag for specifying a sandbox for project commands
* `sandbox upgrade` command will no longer ask which sandbox to upgrade when executed from inside a project's folder
* `project sandbox` command now outputs current project's sandbox


=== Bug fixes

* Removed unsupported options for `upgrade` and `uninstall` commands

== CLI 2 Update 8

=== Features

Expand All @@ -13,7 +35,7 @@
* `--force` flag should use default destination folder for a new project
* _(latest, stable)_ should not be displayed for Beta/RC versions

== v2.7.0
== CLI 2 Update 7

=== Features

Expand All @@ -28,14 +50,14 @@
* Problem stopping a sandbox on Mac/Linux
* Can't use camelCase in project name in the global `create` command

== v2.6.0
== CLI 2 Update 6

=== Features

* `upgrade` command
* `uninstall` command

== v2.5.0
== CLI 2 Update 5

=== Features

Expand All @@ -56,7 +78,7 @@
* Comparison of user input with a sandbox name should be case-insensitive
* Github bash cant select from lists

== v2.4.0
== CLI 2 Update 4

=== Features

Expand All @@ -70,34 +92,18 @@
* Incorrect error message for `app install` command
* The template adds "Enonic CLI" to the usage
* 'Stopping sandbox' message shown after the sandbox is stopped


== v2.3.3

=== Bug fixes

* CLI fails to download distro for XP versions below 7.10.0

== v2.3.2

=== Bug fixes

* Detect when CLI is running on Mac arm64 and pick the right XP sdk

== v2.3.1

=== Bug fixes

* Reinstalling cli through snapcraft after it was manually installed fails
* Reinstalling CLI through snapcraft after it was manually installed fails
* Account query is no longer available

== v2.3.0
== CLI 2 Update 3

=== Features

* Switched to Nexus Repository.

== v2.2.0
== CLI 2 Update 2

=== Features

Expand All @@ -107,14 +113,12 @@

* Project can now be built without a sandbox (with `--force` flag).

== v2.1.1

=== Bug fixes

* Fix "_empty dump name_" error when doing `dump upgrade`
* Fix excessive help text when creating a new project

== v2.1.0
== CLI 2 Update 1

=== Improvements

Expand All @@ -123,20 +127,10 @@
=== Bug fixes

* Fix access token parsing

== v2.0.2

=== Bug fixes

* Fix JWT expiration handling

== v2.0.1

=== Bug fixes

* App install confuses force flag with jar file path

== v2.0.0
== CLI 2

=== Features

Expand All @@ -161,14 +155,9 @@
* Snapcraft installation on Ubuntu not working
* Sandbox not properly deleted if running
* Check for illegal characters in sandbox names

== v1.5.1

=== Bug fixes

* Allow setting number of replicas to 0

== v1.5.0
== CLI 1 Update 5

=== Features

Expand All @@ -184,7 +173,7 @@
* Fixed permissions on `cloud` folder
* Command `enonic project ?` always returns exit code 0

== v1.4.0
== CLI 1 Update 4

=== Improvements

Expand All @@ -196,7 +185,7 @@
* `latest` returns incorrect result when called the first time
* Command `enonic project ?` always returns exit code 0

== v1.3.0
== CLI 1 Update 3

=== Improvements

Expand All @@ -207,22 +196,17 @@
=== Bug fixes

* `enonic repo readonly` command unnecessarily closes indices

== v1.2.1

=== Bug fixes

* Enonic sandbox does not start in detached mode on CentOS7/macOS
* `deploy` command erases runtime PID info when sandbox was started in detached mode
* `install` command gives NPE when env variable is not defined and host is not provided

== v1.2.0
== CLI 1 Update 2

=== Improvements

* Add support for proxy

== v1.1.1
== CLI 1 Update 1

=== Improvements

Expand All @@ -233,7 +217,7 @@
* CLI asks to start the sandbox that is already running
* Remove _enonic-xp-_ from distro name in the sandbox list

== v.1.1.0
== CLI 1

=== Features

Expand Down
3 changes: 2 additions & 1 deletion docs/xp.adoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -798,7 +798,7 @@ $ enonic auditlog cleanup --age P30D

Permanently removes old versions and deleted items from disk.

To support `snapshot restore` and a rich version history, XP does not physically remove the data from disk. The side-effect is that the disk usage will keep growing, even if you delete nodes from the repository. Vacuum command permanently removes old unused versions, as well as deleted nodes from disk. XP defines a default threshold of 21 days (configurable). This basically means that only items deleted at least 21 days ago, or version that are older than 21 days will be vacuumed.
To support `snapshot restore` and a rich version history, XP does not physically remove the data from disk. The side-effect is that the disk usage will keep growing, even if you delete nodes from the repository. Vacuum command permanently removes old unused versions, as well as deleted nodes from disk. XP defines a default threshold of 21 days (configurable). This basically means that only items deleted at least 21 days ago, or version that are older than 21 days will be vacuumed.

NOTE: Using the `-b` option will remove the underlying blobs, meaning restoring a snapshot that is older than 21 days (since last vacuum) will result in an inconsistent and broken dataset.

Expand All @@ -814,6 +814,7 @@ $ enonic vacuum -h
OPTIONS:
--blob, -b Also removes unused blobs
--threshold, -t Age of data to be removed in ISO-8601 duration format PnDTnHnMn.nS with days considered to be exactly 24 hours
--auth value, -a value Authentication token for basic authentication (user:password)
--force, -f Accept default answers to all prompts and run non-interactively
----
Expand Down

0 comments on commit 46ab768

Please sign in to comment.