Skip to content

Commit c9b3d1b

Browse files
committed
docs: improve dev env setup documentation
1 parent f48aba0 commit c9b3d1b

File tree

3 files changed

+35
-24
lines changed

3 files changed

+35
-24
lines changed

CONTRIBUTING.md

Lines changed: 35 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -37,36 +37,47 @@ Latest builds, for testing, can be found at https://download.eclipse.org/tm4e/sn
3737

3838
### ⌨️ Setting up the Development Environment manually
3939

40-
- Download and install the **Eclipse IDE for Eclipse Committers** from https://www.eclipse.org/downloads/packages/ or another
41-
Eclipse installation with the [Plug-in Development Environment (PDE)](https://www.eclipse.org/pde/) installed.
42-
- Clone this repository <a href="https://mickaelistria.github.io/redirctToEclipseIDECloneCommand/redirect.html"><img src="https://mickaelistria.github.io/redirctToEclipseIDECloneCommand/cloneToEclipseBadge.png" alt="Clone to Eclipse IDE"/></a>.
43-
- _File > Open Projects from Filesystem..._ , select the path to the TM4E Git repository and the relevant child projects you want to import
40+
1. Download and install the **Eclipse IDE for Eclipse Committers** from https://www.eclipse.org/downloads/packages/ or another
41+
Eclipse installation with the [Plug-in Development Environment (PDE)](https://www.eclipse.org/pde/) installed.
42+
1. Clone this repository <a href="https://mickaelistria.github.io/redirctToEclipseIDECloneCommand/redirect.html"><img src="https://mickaelistria.github.io/redirctToEclipseIDECloneCommand/cloneToEclipseBadge.png" alt="Clone to Eclipse IDE"/></a>.
43+
1. _File > Import > Existing Maven Project_, select the path to the TM4E Git repository and import projects and all modules
44+
![](documentation/import_project.png)
45+
1. To solve the compiler errors, open the [target-platforms/oldest.target](target-platforms/oldest.target) file in Eclipse, wait until all dependencies are resolved, and click on _**Set as Active Target Platform**_
46+
![](documentation/configure_target_platform.png)
4447

45-
### 🏗️ Build
48+
### 🏗️ Build & Test
4649

47-
- From the command line run:
48-
- on Windows `mvnw clean verify`
49-
- on Linux `./mvnw clean verify`
50-
- From within Eclipse with [M2E](https://www.eclipse.org/m2e/) installed: right-click on the tm4e root folder > Run As > Maven build
50+
1. **On command line**
5151

52-
#### Running the CI job locally:
52+
On Windows execute `mvnw clean verify`\
53+
On Linux execute `./mvnw clean verify`
5354

54-
TM4E's [GitHub Actions wokflow](.github/workflows/build.yml) is compatible with [nektos/act](https://github.com/nektos/act) a
55-
command-line tool that allows you to run GitHub Actions workflows locally.
55+
2. **Within Eclipse**
5656

57-
1. Install Docker
58-
1. Install [nektos/act](https://github.com/nektos/act)
59-
1. From the command line navigate into the tm4e project root
60-
1. Run the command `act`
61-
1. On subsequent re-runs you can use `act -r` to reuse previous container which avoids re-installation system packages and
62-
reduces build times.
57+
- To run full Maven builds: Having [M2E](https://www.eclipse.org/m2e/) installed, right-click on the tm4e root folder > _Run As > Maven build_
6358

64-
In case of build failures the docker container will still be running and you can SSH into it for analysis
65-
using `docker exec -u root -it <CONTAINER_ID> /bin/bash`, e.g.:
66-
```bash
67-
container_id=$(docker container ps --filter status=running --filter name=act-Build-build --format {{.ID}})
68-
docker exec -u root -it $container_id /bin/bash
69-
```
59+
- To run the non-UI tests of any imported module, right-click on the respective project and select > _RunAs > JUnit Test_
60+
61+
- To run the UI tests, right-click on the `org.eclipse.tm4e.ui.tests` project and select > _RunAs > JUnit Plug-in Test_
62+
63+
3. **Running the CI job locally:**
64+
65+
TM4E's [GitHub Actions wokflow](.github/workflows/build.yml) is compatible with [nektos/act](https://github.com/nektos/act) a
66+
command-line tool that allows you to run GitHub Actions workflows locally.
67+
68+
1. Install Docker
69+
1. Install [nektos/act](https://github.com/nektos/act)
70+
1. From the command line navigate into the tm4e project root
71+
1. Run the command `act`
72+
1. On subsequent re-runs you can use `act -r` to reuse previous container which avoids re-installation system packages and
73+
reduces build times.
74+
75+
In case of build failures the docker container will still be running and you can SSH into it for analysis
76+
using `docker exec -u root -it <CONTAINER_ID> /bin/bash`, e.g.:
77+
```bash
78+
container_id=$(docker container ps --filter status=running --filter name=act-Build-build --format {{.ID}})
79+
docker exec -u root -it $container_id /bin/bash
80+
```
7081

7182
### ⬆️ Version bump
7283

27.3 KB
Loading

documentation/import_project.png

15.2 KB
Loading

0 commit comments

Comments
 (0)