Skip to content

Commit

Permalink
Merge branch 'main' into feature/devonfw#103-implement-version-securi…
Browse files Browse the repository at this point in the history
…ty-checks
  • Loading branch information
jan-vcapgemini committed Apr 2, 2024
2 parents ba4bc07 + 25c76a6 commit d794e67
Show file tree
Hide file tree
Showing 3 changed files with 49 additions and 2 deletions.
2 changes: 0 additions & 2 deletions documentation/IDEasy-usage.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
38 changes: 38 additions & 0 deletions documentation/projects.adoc
Original file line number Diff line number Diff line change
@@ -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.
11 changes: 11 additions & 0 deletions documentation/updates.adoc
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit d794e67

Please sign in to comment.