From fdf16807afba441c1cf1912cf2514ec57212a35f Mon Sep 17 00:00:00 2001 From: Hannes Wellmann Date: Sat, 3 Jul 2021 10:48:59 +0200 Subject: [PATCH 1/2] [Doc] improve ReadMe and Contributing (Debugging- and Snapshot-section) --- CONTRIBUTING.md | 30 ++++++++++++++++++++++++++---- README.md | 8 ++++---- 2 files changed, 30 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e54ede92d9..8f57a10e22 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,7 +4,19 @@ Thanks for your interest in this project. ## Try SNAPSHOTs and report issues -To enable SNAPSHOTs, make sure the following Maven repository is available to your build: https://repo.eclipse.org/content/repositories/tycho-snapshots/ . +To enable SNAPSHOTs, make sure the following Maven plugin-repository is available to your build: https://repo.eclipse.org/content/repositories/tycho-snapshots/ . +This can be accomplished by adding the following snippet to your (parent) pom.xml or settings.xml: +``` + + + tycho-snapshots + https://repo.eclipse.org/content/repositories/tycho-snapshots/ + + +``` +Make sure you have set the property for the Tycho version (e.g. `tycho-version`) to `-SNAPSHOT`in the project beeing build. + +For documentation of the most recent snapshot build, see the [Snapshot Tycho Site](https://ci.eclipse.org/tycho/job/tycho-sitedocs/lastSuccessfulBuild/artifact/target/staging/index.html). If you identify an issue, please try to reduce the case to the minimal project and steps to reproduce, and then report the bug with details to reproduce and the minimal reproducer project to Tycho's [issue tracker](./issues). @@ -124,7 +136,15 @@ Tycho has Maven dependencies to Equinox and JDT, so these artifact are used from ## 🏗️ Build & Test -`mvn clean install -Pits` +From the root directory of your local Tycho git-repository clone run the following Maven commands... +* to check if compilation and all tests succeed: + * `mvn clean verify -Pits` +* to install your version of Tycho into your local Maven repository (skips all tests for faster installation): + * `mvn clean install -DSkipTests` + +In order to test your changes of Tycho locally in a project-build, install your modified Tycho locally as described above +and use the corresponding Tycho (probably snapshot) version in the project being build. +You can also debug that build with the steps below (from here you can jump to step 3 immediately). ## Debugging @@ -132,9 +152,11 @@ In order to debug Tycho plugins inside Eclipse: 1. Get the Tycho sources in Eclipse 2. Create/get a project that highlights the bug -3. Run the project with `mvnDebug clean install` -4. Go into your Eclipse, use `Debug > Remote Java Application`, select port 8000 +3. Create a Maven Run-Configuration in your Tycho Eclipse-workspace to build the project, specify goals, profiles and properties as required. +4. Launch the Maven-configuration from your Eclipse in Debug-mode +Before debugging a build, you should make sure that your local Tycho-sources correspond to the Tycho version used by the project being build. +Otherwise the debugger may behaves unexpected. ## Commits diff --git a/README.md b/README.md index 65f15da113..e1cee0db04 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,13 @@ with Maven. * 👔 Eclipse project entry: https://projects.eclipse.org/projects/technology.tycho * 🗒️ Documentation (some content to be reincorporated into this repository): - * https://www.eclipse.org/tycho/sitedocs/ - * https://wiki.eclipse.org/Tycho/ + * https://www.eclipse.org/tycho/sitedocs/ + * https://wiki.eclipse.org/Tycho/ +* 📢 Release notes: [RELEASE_NOTES.md](./RELEASE_NOTES.md) * 🪲 Bug Tracker * New https://github.com/eclipse/tycho/issues * Legacy https://bugs.eclipse.org/bugs/buglist.cgi?product=Tycho -* ⌨️ How to Contribute: [CONTRIBUTING.md](./CONTRIBUTING.md) +* ⌨️ How to Contribute and latest snapshots: [CONTRIBUTING.md](./CONTRIBUTING.md) * 💬 Community mailing-lists * Usage assistance https://dev.eclipse.org/mailman/listinfo/tycho-user * Development https://dev.eclipse.org/mailman/listinfo/tycho-dev - \ No newline at end of file From 369e78673047633369eabf81b6331cf4fe169af2 Mon Sep 17 00:00:00 2001 From: Hannes Wellmann Date: Mon, 5 Jul 2021 09:04:20 +0200 Subject: [PATCH 2/2] [SQUASH] keep mvnDebug option in the debugging section. Change-Id: Id669c0c96bdcfa700a0bb890189504b5dc62f7dc Signed-off-by: Hannes Wellmann --- CONTRIBUTING.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8f57a10e22..196d77a59d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -152,11 +152,19 @@ In order to debug Tycho plugins inside Eclipse: 1. Get the Tycho sources in Eclipse 2. Create/get a project that highlights the bug -3. Create a Maven Run-Configuration in your Tycho Eclipse-workspace to build the project, specify goals, profiles and properties as required. + +Inside the Eclipse IDE: + +3. Create a Maven Run-Configuration in your Tycho Eclipse-workspace to build the project and specify goals, profiles and properties as required 4. Launch the Maven-configuration from your Eclipse in Debug-mode -Before debugging a build, you should make sure that your local Tycho-sources correspond to the Tycho version used by the project being build. -Otherwise the debugger may behaves unexpected. +Or on the command-line interface: + +3. Run the project-build using `mvnDebug` (instead of `mvn`) and specify goals, profiles and properties as required +4. Go into your Eclipse, use `Debug > Remote Java Application`, select `port 8000` to attach the Eclipse Debugger + +Before debugging a build, make sure that your local Tycho-sources correspond to the Tycho version used by the project being build. +Otherwise the debugger might show unexpected behavior. ## Commits