From 25c76a61f682064867ecd044d2240498f1050e8b Mon Sep 17 00:00:00 2001 From: Carsten Reitz <95033856+CREITZ25@users.noreply.github.com> Date: Tue, 2 Apr 2024 09:06:39 +0200 Subject: [PATCH 1/3] #265: Correction in IDEasy-usage.adoc (#266) Repair the links for projects and updates and delete the link for scripts --- documentation/IDEasy-usage.adoc | 2 -- documentation/projects.adoc | 38 +++++++++++++++++++++++++++++++++ documentation/updates.adoc | 11 ++++++++++ 3 files changed, 49 insertions(+), 2 deletions(-) create mode 100644 documentation/projects.adoc create mode 100644 documentation/updates.adoc diff --git a/documentation/IDEasy-usage.adoc b/documentation/IDEasy-usage.adoc index 82e720c92..a6376d050 100644 --- a/documentation/IDEasy-usage.adoc +++ b/documentation/IDEasy-usage.adoc @@ -24,8 +24,6 @@ include::conf.adoc[leveloffset=3] include::log.adoc[leveloffset=3] -include::scripts.adoc[leveloffset=3] - include::settings.adoc[leveloffset=3] include::software.adoc[leveloffset=3] diff --git a/documentation/projects.adoc b/documentation/projects.adoc new file mode 100644 index 000000000..8b53e094e --- /dev/null +++ b/documentation/projects.adoc @@ -0,0 +1,38 @@ +:toc: +toc::[] + += Project import + +The `devonfw-ide` supports to automatically check out and import required projects into your IDE during link:setup.asciidoc[setup]. To configure this you put a `.properties` file for each desired project into the `projects` sub-folder in your link:settings.asciidoc[settings]. Each `.properties` file describes one "project" which you would like to check out and (potentially) import: + +[source, properties] +---- +path=myproject +workingsets=Set1,Set2 +workspace=example +git_url=http://github.com/someorg/someproject +git_branch=develop +build_path=. +build_cmd=mvn -DskipTests=true -Darchetype.test.skip=true clean install +eclipse=import +active=true +---- + + .Variables of project import +[options="header"] +|=== +|*Variable*|*Value*|*Meaning* +|`path`|e.g. `myproject`, will clone into `${WORKSPACE_PATH}/myproject`|(required) Path into which the projects is cloned. This path is relative to the workspace. +|`working sets`|e.g. `ws1,ws2`|(optional) This will create working sets (in eclipse). Each module (eclipse project) of this project will be part of all these working sets. Working sets will be automatically created if necessary. +|`workspace`|`main`|Workspace to use for checkout and import. Default is `main`. +|`git_url`|e.g. `http://github.com/someorg/someproject`|(required) Git URL to use for cloning the project. +|`git_branch`|e.g. `develop`|(optional) Git branch to checkout. Git default branch is default. +|`build_path`|e.g. `.` (default)|(optional) The directory inside `path` where to trigger an initial build after clone or pull (if `build_cmd` is set). For a regular project use `.` to build top-level project. +|`build_cmd` +|e.g. `mvn -D skip Tests=true -Darchetype.test.skip=true clean install` +|(optional) The _devonfw_ command to invoke to build the project after clone or pull. If omitted no build is triggered. +|`eclipse`|e.g. `import`|(optional) Desired action for eclipse IDE. If you put `import` here all modules (eclipse projects) in the current project will be imported into eclipse. If you leave this out or put any other value for this parameter, no change in eclipse is done. +|`active`|`true`|(optional) If set to `false` the project is skipped during the link:setup.asciidoc[setup]. +|=== + +Please note that the `.properties` file is parsed via shell and not via java. So be careful with "advanced" features `.properties` files normally support. diff --git a/documentation/updates.adoc b/documentation/updates.adoc new file mode 100644 index 000000000..dc22b8f7e --- /dev/null +++ b/documentation/updates.adoc @@ -0,0 +1,11 @@ +:toc: +toc::[] + += updates + +The `updates` folder is used for temporary data. This includes: + +* extracted archives for installation and updates +* backups of old content on updates to prevent data loss + +If all works fine you may clean this folder to save some kilo- or mega-bytes. Otherwise, you can ignore it unless you are looking for a backup after a failed or unplanned upgrade. \ No newline at end of file From c5edff9753479b9d1f08178378ad4bdcfea325a9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Hohwiller?= Date: Tue, 2 Apr 2024 13:51:59 +0200 Subject: [PATCH 2/3] bumped version to 2024.03.001-alpha --- .mvn/maven.config | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.mvn/maven.config b/.mvn/maven.config index edd4b2730..40a8e84e0 100644 --- a/.mvn/maven.config +++ b/.mvn/maven.config @@ -1 +1 @@ --Drevision=2024.03.001-alpha-SNAPSHOT +-Drevision=2024.03.001-alpha From 5815a892df7ecc268957dd8bd21e3c9e106379ba Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?J=C3=B6rg=20Hohwiller?= Date: Tue, 2 Apr 2024 13:57:16 +0200 Subject: [PATCH 3/3] set version to 2024.04.001-alpha-SNAPSHOT --- .mvn/maven.config | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.mvn/maven.config b/.mvn/maven.config index 40a8e84e0..68b7eb3ab 100644 --- a/.mvn/maven.config +++ b/.mvn/maven.config @@ -1 +1 @@ --Drevision=2024.03.001-alpha +-Drevision=2024.04.001-alpha-SNAPSHOT