Skip to content

Commit

Permalink
Add stub API JAR file so compilation succeeds
Browse files Browse the repository at this point in the history
  • Loading branch information
David Conneely committed Jun 13, 2017
1 parent d0bc6b0 commit 8bc94cb
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 4 deletions.
5 changes: 2 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,8 @@
/.project
/.settings/
/bin/
/lib/*
!/lib/README.md
/logs/
/nbactions.xml
/nb-configuration.xml
/target/
/work/
/work/
11 changes: 11 additions & 0 deletions lib/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
## Purpose of this directory

This `lib` directory contains a `dmclient-stub.jar` stub Java API for Dimensions CM.

The stub API includes interfaces but not implementations for the Java API for Dimensions CM consumed by this Jenkins Dimensions Plugin.

The stub API is _not_ functional, but is provided solely to allow the code in this Git repository to compile, and for no other reason.

The stub API JAR file must _not_ be included in the built HPI/JPI plugin file because it will prevent the real Java API for Dimensions CM from working correctly. This is why the stub API JAR is given as a `system` dependency in `pom.xml`.

The above means that the [**Installation**](https://wiki.jenkins-ci.org/display/JENKINS/Dimensions+Plugin#DimensionsPlugin-Installation) steps on the wiki page still apply. This means copying the named API JAR files from your Dimensions CM Server into the appropriate subdirectory of your Jenkins installation.
Binary file added lib/dmclient-stub.jar
Binary file not shown.
4 changes: 3 additions & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -77,11 +77,13 @@
The Dimensions CM dmclient.jar file must be installed into your local Maven repository.
Note the following does not mean that a particular version of the API is required:
Older JARs (back to 10.1.3) also work, because the plugin only calls older API classes and methods.
dmclient-stub.jar contains only stub APIs with no implementation solely to allow the code to compile.
-->
<groupId>com.serena.dimensions</groupId>
<artifactId>dmclient</artifactId>
<version>14.4.0-SNAPSHOT</version>
<scope>provided</scope>
<scope>system</scope>
<systemPath>${project.basedir}/lib/dmclient-stub.jar</systemPath>
</dependency>
</dependencies>
</project>

0 comments on commit 8bc94cb

Please sign in to comment.