Skip to content

Commit 9e03ccd

Browse files
committed
EConDec-6: Manage dependencies via Maven (#8)
[issue] How can we enable to run the plug-in in Eclipse without including the .jar libs in the git repo? How can we manage the dependencies via maven for an Eclipse plug-in? [/issue] [decision] Add maven-dependency-plugin with the copy-dependencies goal to copy the necessary libraries from the .m2 folder to the lib folder! [/decision] * Add installation description to README
1 parent 9a55f51 commit 9e03ccd

File tree

13 files changed

+527
-222
lines changed

13 files changed

+527
-222
lines changed

.gitignore

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,8 @@
44
target/
55
.idea/
66
.metadata/
7+
lib/
78

89
# Files
9-
.settings
1010
*.iml
11-
*.class
12-
.classpath
11+
*.class

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,38 @@
44
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/8e6c96d73a3c4b4aa30d9a2173795233)](https://www.codacy.com/app/UHD/cures-condec-eclipse?utm_source=github.com&utm_medium=referral&utm_content=cures-hub/cures-condec-eclipse&utm_campaign=Badge_Grade)
55
[![Codecoverage](https://codecov.io/gh/cures-hub/cures-condec-eclipse/branch/master/graph/badge.svg)](https://codecov.io/gh/cures-hub/cures-condec-eclipse/branch/master)
66

7-
The CURES ConDec Eclipse plug-in enables the user to capture and explore decision knowledge in Eclipse. Decision knowledge covers knowledge about decisions, the problems they address, solution proposals, their context, and justifications (rationale). The user can capture decision knowledge in code and commit messages and explore relevant knowledge for code. Relevant knowledge is also extracted from the JIRA project.
7+
The CURES ConDec Eclipse plug-in enables the user to capture and explore decision knowledge in Eclipse. Decision knowledge covers knowledge about decisions, the problems they address, solution proposals, their context, and justifications (rationale). The user can capture decision knowledge in code and commit messages and explore relevant knowledge for code. Relevant knowledge is also extracted from the JIRA project.
8+
9+
## Installation
10+
11+
### Prerequisites
12+
The following prerequisites are necessary to compile the plug-in from source code:
13+
- Java 8 JDK
14+
- [Maven 3](https://maven.apache.org)
15+
16+
### Compilation via Terminal
17+
The source code can be compiled via terminal.
18+
Navigate into the cures-condec-eclipse folder and run the following command:
19+
```
20+
mvn clean install
21+
```
22+
The cures-condec-eclipse.jar file is created in the de.uhd.ifi.se.decision.management.eclipse/target subfolder.
23+
24+
### Download of Precompiled .jar-File
25+
The precompiled .jar-File for the latest release can be found here: https://github.com/cures-hub/cures-condec-eclipse/releases/latest
26+
27+
### Develop in Eclipse
28+
To evolve the ConDec Eclipse plug-in, it needs to be imported into Eclipse.
29+
- [Install Eclipse IDE for RCP and RAP Developers](https://www.eclipse.org/downloads/packages/) and open it.
30+
- Import the project as an Existing Maven Project.
31+
- Run *mvn clean install* in the parent project (cures-condec-eclipse folder) to download the necessary dependendencies into the de.uhd.ifi.se.decision.management.eclipse/lib folder.
32+
- Configure the de.uhd.ifi.se.decision.management.eclipse project: Properties / Java Build Path / Libraries /
33+
- Add JARs... / select all jar-files in the lib folder (if not already included).
34+
- Add Library... / select the *Plug-in Dependencies* (if not already included).
35+
36+
### Installation in Eclipse
37+
- Download or compile the cures-condec-eclipse.jar file.
38+
- [Install Eclipse](https://www.eclipse.org/downloads/packages/).
39+
- Navigate to the Eclipse installation folder and copy the cures-condec-eclipse.jar file into the dropins folder (or a similar folder depending on your operation system).
40+
- Open Eclipse.
41+
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
activeProfiles=
2+
eclipse.preferences.version=1
3+
resolveWorkspaceProjects=true
4+
version=1
Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<classpath>
3+
<classpathentry exported="true" kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.8"/>
4+
<classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
5+
<classpathentry kind="src" path="src/">
6+
<attributes>
7+
<attribute name="test" value="true"/>
8+
</attributes>
9+
</classpathentry>
10+
<classpathentry kind="output" path="target/classes"/>
11+
</classpath>

de.uhd.ifi.se.decision.management.eclipse.tests/src/de/uhd/ifi/se/decision/management/eclipse/extraction/TestGitClient.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ public class TestGitClient {
2222

2323
@Before
2424
public void setUp() {
25-
new GitClientImpl("C:\\Users\\anja\\Documents\\gits\\theses\\martinseiler\\.git", "HEAD");
25+
new GitClientImpl(".git", "HEAD");
2626
new File("");
2727
}
2828

@@ -34,7 +34,7 @@ public void tearDown() {
3434
@Ignore
3535
public void testMessagesExists() {
3636

37-
IPath repositoryPathMS = new Path("C:\\Users\\anja\\Documents\\gits\\theses\\martinseiler\\");
37+
IPath repositoryPathMS = new Path("");
3838

3939
GitClient myExtractor = new GitClientImpl(repositoryPathMS + ".git", "HEAD");
4040

@@ -57,7 +57,7 @@ public void testMessagesExists() {
5757
@Ignore
5858
public void testMessagesAndIDExist() {
5959

60-
IPath repositoryPathMS = new Path("C:\\Users\\anja\\Documents\\gits\\theses\\martinseiler\\");
60+
IPath repositoryPathMS = new Path("");
6161

6262
GitClient myExtractor = new GitClientImpl(repositoryPathMS + ".git", "HEAD");
6363

de.uhd.ifi.se.decision.management.eclipse.tests/src/de/uhd/ifi/se/decision/management/eclipse/extraction/TestJiraClient.java

Lines changed: 0 additions & 120 deletions
This file was deleted.

0 commit comments

Comments
 (0)