initial changes for Maven central releasing, jar name to non-capital letters, meta info to pom.xml, documentation updates

Author: sampeson

BUILD.md

@@ -20,16 +20,15 @@ JavaFXLibrary uses Apache Maven as a build tool.
   mismatches with Google Guava dependencies.  See https://maven.apache.org/plugins/maven-shade-plugin/ for more info.
 
 
-
 ## Releasing
 
 * update library version to x.x.x in pom.xml
 * run tests ``mvn clean verify``
-* copy target/robotframework/libdoc/JavaFXLibrary.html under docs directory
-* ``git commit -m "version to x.x.x" pom.xml docs/JavaFXLibrary.html``
+* copy target/robotframework/libdoc/javafxlibrary.html under docs directory (check that README.md links to correct file)
+* ``git commit -m "version to x.x.x" pom.xml docs/javafxlibrary.html``
 * create tag ``git tag -a x.x.x``
 * push ``git push origin master`` and ``git push origin x.x.x``
-* create a new release and upload the jar file, html documentation and xml file to https://github.com/robotframework/JavaFXLibrary/releases
+* create a new release and upload the jar file, html documentation and xml file to https://github.com/eficode/JavaFXLibrary/releases 
 * upload to Maven Repository (TBD)
 
 ## Announcements

README.md

@@ -17,13 +17,13 @@ See keyword [documentation](https://eficode.github.io/JavaFXLibrary/JavaFXLibrar
 1. Download latest JavaFXLibrary and documentation from https://github.com/robotframework/JavaFXLibrary/releases/
 2. Copy(if needed) JAR to desired location and run from command line using
     ```
-    java -jar JavaFXLibrary-<version>.jar
+    java -jar javafxlibrary-<version>.jar
 
     ```
 3. JavaFXLibrary in RemoteServer mode should now be running in port [8270](http://localhost:8270)
 4. Optionally JAR can be launched with port number as an optional argument:
     ```
-    java -jar JavaFXLibrary-<version>.jar 1234
+    java -jar javafxlibrary-<version>.jar 1234
     ```
 5. JavaFXLibrary in RemoteServer mode should now be running in port [1234](http://localhost:1234)
 
@@ -68,12 +68,12 @@ mvn verify
 
 Windows command line:
 ```
-java -cp "target\JavaFXLibrary-<version>.jar"  org.robotframework.RobotFramework --include smoke src\test\robotframework/
+java -cp "target\javafxlibrary-<version>.jar"  org.robotframework.RobotFramework --include smoke src\test\robotframework/
 ```
 
 Linux/OSX command line:
 ```
-java -cp "target/JavaFXLibrary-<version>.jar"  org.robotframework.RobotFramework --include smoke src/test/robotframework/
+java -cp "target/javafxlibrary-<version>.jar"  org.robotframework.RobotFramework --include smoke src/test/robotframework/
 
 ```
 

pom.xml

@@ -19,16 +19,17 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
     <modelVersion>4.0.0</modelVersion>
     <groupId>org.robotframework</groupId>
-    <artifactId>JavaFXLibrary</artifactId>
+    <artifactId>javafxlibrary</artifactId>
     <packaging>jar</packaging>
     <version>0.4.2-SNAPSHOT</version>
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
     </properties>
 
-    <name>JavaFXLibrary</name>
+    <name>${project.groupId}:${project.artifactId}</name>
     <description>JavaFXLibrary for the Robot Framework.</description>
     <url>https://github.com/eficode/JavaFXLibrary/</url>
+
     <licenses>
         <license>
             <name>The Apache Software License, Version 2.0</name>
@@ -37,13 +38,67 @@
             <comments>A business-friendly OSS license</comments>
         </license>
     </licenses>
+
+    <developers>
+        <developer>
+            <name>Jukka Haavisto</name>
+            <email>jukka.haavisto@eficode.com</email>
+            <organization>Eficode</organization>
+            <organizationUrl>http://www.eficode.com</organizationUrl>
+        </developer>
+        <developer>
+            <name>Sami Pesonen</name>
+            <email>sami.pesonen@eficode.com</email>
+            <organization>Eficode</organization>
+            <organizationUrl>http://www.eficode.com</organizationUrl>
+        </developer>
+        <developer>
+            <name>Pasi Saikkonen</name>
+            <email>pasi.saikkonen@eficode.com</email>
+            <organization>Eficode</organization>
+            <organizationUrl>http://www.eficode.com</organizationUrl>
+        </developer>
+    </developers>
+
     <issueManagement>
         <system>Github Issues</system>
         <url>https://github.com/eficode/JavaFXLibrary/issues</url>
     </issueManagement>
 
+    <scm>
+        <connection>scm:git:git://github.com/eficode/JavaFXLibrary.git</connection>
+        <developerConnection>scm:git:ssh://github.com:eficode/JavaFXLibrary.git</developerConnection>
+        <url>http://github.com/eficode/JavaFXLibrary/tree/master</url>
+    </scm>
+
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-source-plugin</artifactId>
+                <version>3.0.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-sources</id>
+                        <goals>
+                            <goal>jar-no-fork</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.0.1</version>
+                <executions>
+                    <execution>
+                        <id>attach-javadocs</id>
+                        <goals>
+                            <goal>jar</goal>
+                        </goals>
+                    </execution>
+                </executions>
+            </plugin>
             <plugin>
                 <artifactId>maven-compiler-plugin</artifactId>
                 <version>3.6.1</version>
@@ -125,7 +180,7 @@
                         <configuration>
                             <libdoc>
                                 <outputFile>${project.artifactId}.html</outputFile>
-                                <libraryOrResourceFile>${project.artifactId}</libraryOrResourceFile>
+                                <libraryOrResourceFile>JavaFXLibrary</libraryOrResourceFile>
                                 <version>${project.version}</version>
                             </libdoc>
                         </configuration>
@@ -139,7 +194,7 @@
                         <configuration>
                             <libdoc>
                                 <outputFile>${project.artifactId}.xml</outputFile>
-                                <libraryOrResourceFile>${project.artifactId}</libraryOrResourceFile>
+                                <libraryOrResourceFile>JavaFXLibrary</libraryOrResourceFile>
                                 <version>${project.version}</version>
                             </libdoc>
                         </configuration>

src/main/java/JavaFXLibrary.java

@@ -91,7 +91,7 @@ public Object runKeyword(String keywordName, Object[] args) {
     public String getKeywordDocumentation(String keywordName) {
         if (keywordName.equals("__intro__")) {
             try {
-                return FileUtils.readFileToString(new File("libdoc-documentation.txt"), "utf-8");
+                return FileUtils.readFileToString(new File("./src/main/java/libdoc-documentation.txt"), "utf-8");
             } catch (IOException e) {
                 e.printStackTrace();
                 return "IOException occured while reading the documentation file!";

libdoc-documentation.txt src/main/java/libdoc-documentation.txtlibdoc-documentation.txt renamed to src/main/java/libdoc-documentation.txt

@@ -24,11 +24,11 @@ First, the JavaFXLibrary needs to be taken into use in the settings table.
 
 === 2.2 Usage in remote mode(Jython & Python) ===
 When using the test library in remote mode, the library needs to be started at the remote end first. This can be done as follows:
-- _java -jar JavaFXLibrary-<version>.jar_
+- _java -jar javafxlibrary-<version>.jar_
 This will start the remote server listening at default port number 8270.
 
 If there is a need to use a different port the library can be started with optional parameter:
-- _java -jar JavaFXLibrary-<version>.jar 1234_
+- _java -jar javafxlibrary-<version>.jar 1234_
 This will start the remote server listening on port 1234.
 
 JavaFXLibrary can be taken into use as remote library in settings table as follows: