Update Build-Instruction and remove redundant bundle (#1345)

* Update Build-Instruction and remove redundant bundle

* Update pom.xml

* update

* add script for compile web package and install ide plugins

* Update development_prepare.js

* Update vite.config.js

* Update BUILD_INSTRUCTIONS.md

Co-authored-by: Marius Heine <[email protected]>

* Add maven setting guide

* Add Eclipse IDE plugin

* Update install_eclipse_plugin.sh

* Update install_eclipse_plugin.sh

* make prepare eclipse script executable

* check for eclipse executable and hide debug statements

* fix  lock file

* add hugo build locks to gitignore

* create .env files for web packages

* use curl for better cross compatibility

* add sleep for unzip

* updated build instructions

* fix script under windows

* handle existing eclipse homes better

* fix tar command

* do not unzip pdfjs because this is done by build script

* fix syntax error in if statement

* properly create .env file in all environments

* add .env file to gitignore

* complete maven settings explanation

* fix text and pdf viewer build in CI

---------

Co-authored-by: Marius Heine <[email protected]>

Author: TruongQuangSB

.github/workflows/ci.yml

@@ -65,7 +65,7 @@ jobs:
       - name: Build
         run: |
           npm ci
-          npm run build
+          npm run build-prod
         working-directory: web/textviewer
       - name: Store artifact
         uses: actions/upload-artifact@v4
@@ -82,7 +82,7 @@ jobs:
         run: |
           wget --no-verbose -O pdfjs.zip https://github.com/mozilla/pdf.js/releases/download/v$(node getVersion.js)/pdfjs-$(node getVersion.js)-dist.zip
           npm ci
-          npm run build
+          npm run build-prod
         working-directory: web/pdf
       - name: Store artifact
         uses: actions/upload-artifact@v4

.gitignore

@@ -1,3 +1,5 @@
+.env
+
 # ---> Maven
 target/
 pom.xml.tag
@@ -51,6 +53,7 @@ dist/
 web/about/public
 web/news/public
 .vscode/settings.json
+.hugo_build.lock
 
 # Generated siteplan model
 siteplan*.json

BUILD_INSTRUCTIONS.md

@@ -18,27 +18,98 @@ Other operating systems or processor architectures may work, but are generally n
 - Eclipse IDE (2024-06)
 - [hugo](https://gohugo.io/) (v0.101.0+)
 
-# Development build
+## Maven Settings
+
+The SET project depends on severak modules including SET-Browser (eclipse-set/browser), SET-Model (eclipse-set/model) and others. 
+These modules are available from the Github Maven repository.
+To access them you need to authenticate at Github with your Github account.
+Simply add the following servers config to your maven user profile.
+The env.GITHUB_ACTOR and env.GITHUB_TOKEN can be replaced inline by your Github user name and personal access token or set them as system environment variable.
+
+```
+  <servers>
+    <server>
+      <id>set-github-browser</id>
+      <username>${env.GITHUB_ACTOR}</username>
+      <password>${env.GITHUB_TOKEN}</password>
+    </server>
+    <server>
+      <id>set-github</id>
+      <username>${env.GITHUB_ACTOR}</username>
+      <password>${env.GITHUB_TOKEN}</password>
+    </server>
+    <server>
+      <id>set-github-model</id>
+      <username>${env.GITHUB_ACTOR}</username>
+      <password>${env.GITHUB_TOKEN}</password>
+    </server>
+    <server>
+      <id>set-github-toolboxmodel</id>
+      <username>${env.GITHUB_ACTOR}</username>
+      <password>${env.GITHUB_TOKEN}</password>
+    </server>
+    <server>
+      <id>set-github-build</id>
+      <username>${env.GITHUB_ACTOR}</username>
+      <password>${env.GITHUB_TOKEN}</password>
+    </server>
+  </servers>
+```
+
+## Development setup
+
+To setup the complete development environment you can simply use the bash file _releng/eclipse/prepare_eclipse.sh_.
+This will use an existing eclipse or will download it for you to the provide ECLIPSE_HOME directory.
+
+Under Windows:
+
+```cmd
+set ECLIPSE_HOME=C:/planpro/eclipse
+releng/eclipse/prepare-eclipse.sh
+```
+
+Under linux:
+
+```bash
+ECLIPSE_HOME=~/planpro/eclipse releng/eclipse/prepare-eclipse.sh
+```
+
+## Eclipse IDE Requirement Plugins
+
+The requirement plugins can install through Eclipse IDE (Help -> Installed New Software) or bash file _releng/eclipse/install_eclipse_plugin.sh_ (Need set environment variable `ECLIPSE_HOME`).
+
+||Plugin Name| Install URL|
+|------|------|------|
+1|Eclipse Platform | https://download.eclipse.org/eclipse/updates/4.32
+2|Eclipse RPC Target Components | https://download.eclipse.org/eclipse/updates/4.32
+3|Eclipse Plugin Developments | https://download.eclipse.org/eclipse/updates/4.32
+4|Equinox Target Components | https://download.eclipse.org/eclipse/updates/4.32
+5|Eclipse e4 Tools Developer Resources | https://download.eclipse.org/eclipse/updates/4.32
+6|Xtext Complete SDK | https://download.eclipse.org/releases/2024-06
+7|EMF - Eclipse Modeling Framework SDK | https://download.eclipse.org/releases/2024-06
+8|EMF Forms SDK | http://download.eclipse.org/ecp/releases/releases_127
+9|Ecore Tools | https://download.eclipse.org/ecoretools/updates/releases/3.5.1/2023-06/
+10|M2E PDE Integration | https://download.eclipse.org/releases/2024-06
+11|Checkstyle | https://checkstyle.org/eclipse-cs-update-site
+12|SWTBot for Eclipse Testing | https://download.eclipse.org/releases/2024-06
+
+## Development build
 
 This is the recommended way to build and debug for development. 
 
 1. Clone this repository or download a source archive.
-2. Create a new workspace in the Eclipse IDE
-3. Import projects from `java/` via File -> Import -> Existing Projects into Workspace
-4. Import the Checkstyle configuration from `releng/eclipse/checkstyle.xml` via Window -> Preferences -> Checkstyle
-4. Import the Java formatter configuration from `releng/eclipse/java-formatter.xml` via Window -> Preferences -> Java -> Code Style -> Formatter
-5. Set the target platform in `org.eclipse.set.releng.target`
-6. Launch the product in `org.eclipse.set.releng.set.product`
-7. Adapt the working directory in the launch configuration to a local directory, which contains an unpacked copy of a full Eclipse SET build (use a recent Github Actions build of the same branch for compatibility). 
-
-If you want to work on the embedded web components (e.g. the textviewer or the pdf viewer), you need to: 
-
-1. Browse to the appropriate subfolder in `web/`
-2. Install npm dependencies via `npm install`
-3. Build via `npm run build`
-4. Copy the contents of the resulting `build`-directory to the unpacked Eclipse SET build (in the matching `web/` subdirectory). 
-
-# Production build
+2. Set environment variable `ECLIPSE_HOME`
+3. Run javascript file `releng/eclipse/development_prepare.js` for complie and copy web package to Eclipse IDE directory.
+4. Create a new workspace in the Eclipse IDE
+5. Import projects from `java/` via File -> Import -> Existing Projects into Workspace
+6. Import the Checkstyle configuration from `releng/eclipse/checkstyle.xml` via Window -> Preferences -> Checkstyle
+7. Import the Java formatter configuration from `releng/eclipse/java-formatter.xml` via Window -> Preferences -> Java -> Code Style -> Formatter
+8. Set maven setting file to the setting, which contain above server setting `Window -> Preferences -> Maven -> User Settings`
+9. Set the target platform in `org.eclipse.set.releng.target` by opening the file `org.eclipse.set.releng.target.target` and click on `Set as Target Platform` or `Reload Target Platform` in the top right corner
+10. Synchronize and launch the product in `org.eclipse.set.releng.set.product`
+11. Adapt the working directory in the launch configuration to a local directory, which contains an unpacked copy of a full Eclipse SET build (use a recent Github Actions build of the same branch for compatibility).  
+
+## Production build
 
 This is the recommended way if you want a production-style build. This is also what we have implemented on the Jenkins instance.
 If you want to develop SET, this is not recommended as the subcomponents are relatively stable and are easy to aquire from our download site.

java-test/pom.xml

@@ -140,12 +140,6 @@
           <version>${set-version}</version>
           <type>jar</type>
         </dependency>
-        <dependency>
-          <groupId>org.eclipse.set</groupId>
-          <artifactId>org.eclipse.set.i18n.integrationview.nl_de</artifactId>
-          <version>${set-version}</version>
-          <type>jar</type>
-        </dependency>
         <dependency>
           <groupId>org.eclipse.set</groupId>
           <artifactId>org.eclipse.set.i18n.model.nl_de</artifactId>
@@ -158,18 +152,6 @@
           <version>${set-version}</version>
           <type>jar</type>
         </dependency>
-        <dependency>
-          <groupId>org.eclipse.set</groupId>
-          <artifactId>org.eclipse.set.model.integrationview.edit</artifactId>
-          <version>${set-version}</version>
-          <type>jar</type>
-        </dependency>
-        <dependency>
-          <groupId>org.eclipse.set</groupId>
-          <artifactId>org.eclipse.set.model.integrationview</artifactId>
-          <version>${set-version}</version>
-          <type>jar</type>
-        </dependency>
         <dependency>
           <groupId>org.eclipse.set</groupId>
           <artifactId>org.eclipse.set.model.plazmodel</artifactId>
@@ -182,24 +164,6 @@
           <version>${set-version}</version>
           <type>jar</type>
         </dependency>
-        <dependency>
-          <groupId>org.eclipse.set</groupId>
-          <artifactId>org.eclipse.set.model.simplemerge.edit</artifactId>
-          <version>${set-version}</version>
-          <type>jar</type>
-        </dependency>
-        <dependency>
-          <groupId>org.eclipse.set</groupId>
-          <artifactId>org.eclipse.set.model.simplemerge.extensions</artifactId>
-          <version>${set-version}</version>
-          <type>jar</type>
-        </dependency>
-        <dependency>
-          <groupId>org.eclipse.set</groupId>
-          <artifactId>org.eclipse.set.model.simplemerge</artifactId>
-          <version>${set-version}</version>
-          <type>jar</type>
-        </dependency>
         <dependency>
           <groupId>org.eclipse.set</groupId>
           <artifactId>org.eclipse.set.model.tablemodel.extensions</artifactId>
@@ -498,9 +462,8 @@
             <configuration>
               <configLocation>../../releng/eclipse/checkstyle.xml</configLocation>
               <suppressionsLocation>../../releng/eclipse/suppressions.xml</suppressionsLocation>
-              <propertyExpansion>
-								config_loc=../../../releng/eclipse
-							</propertyExpansion>
+              <propertyExpansion> config_loc=../../../releng/eclipse
+              </propertyExpansion>
               <consoleOutput>true</consoleOutput>
               <linkXRef>false</linkXRef>
               <includes>**\/*.java, **\/*.MF, **\/.xml, **\/.properties</includes>