Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit a57f858

Browse files
sampesonsampeson
committed
initial changes for Maven central releasing, jar name to non-capital letters, meta info to pom.xml, documentation updates
1 parent 5883c44 commit a57f858

File tree

5 files changed

+69
-15
lines changed

5 files changed

+69
-15
lines changed

‎BUILD.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,16 +20,15 @@ JavaFXLibrary uses Apache Maven as a build tool.
2020
mismatches with Google Guava dependencies. See https://maven.apache.org/plugins/maven-shade-plugin/ for more info.
2121

2222

23-
2423
## Releasing
2524

2625
* update library version to x.x.x in pom.xml
2726
* run tests ``mvn clean verify``
28-
* copy target/robotframework/libdoc/JavaFXLibrary.html under docs directory
29-
* ``git commit -m "version to x.x.x" pom.xml docs/JavaFXLibrary.html``
27+
* copy target/robotframework/libdoc/javafxlibrary.html under docs directory (check that README.md links to correct file)
28+
* ``git commit -m "version to x.x.x" pom.xml docs/javafxlibrary.html``
3029
* create tag ``git tag -a x.x.x``
3130
* push ``git push origin master`` and ``git push origin x.x.x``
32-
* create a new release and upload the jar file, html documentation and xml file to https://github.com/robotframework/JavaFXLibrary/releases
31+
* create a new release and upload the jar file, html documentation and xml file to https://github.com/eficode/JavaFXLibrary/releases
3332
* upload to Maven Repository (TBD)
3433

3534
## Announcements

‎README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,13 @@ See keyword [documentation](https://eficode.github.io/JavaFXLibrary/JavaFXLibrar
1717
1. Download latest JavaFXLibrary and documentation from https://github.com/robotframework/JavaFXLibrary/releases/
1818
2. Copy(if needed) JAR to desired location and run from command line using
1919
```
20-
java -jar JavaFXLibrary-<version>.jar
20+
java -jar javafxlibrary-<version>.jar
2121
2222
```
2323
3. JavaFXLibrary in RemoteServer mode should now be running in port [8270](http://localhost:8270)
2424
4. Optionally JAR can be launched with port number as an optional argument:
2525
```
26-
java -jar JavaFXLibrary-<version>.jar 1234
26+
java -jar javafxlibrary-<version>.jar 1234
2727
```
2828
5. JavaFXLibrary in RemoteServer mode should now be running in port [1234](http://localhost:1234)
2929
@@ -68,12 +68,12 @@ mvn verify
6868
6969
Windows command line:
7070
```
71-
java -cp "target\JavaFXLibrary-<version>.jar" org.robotframework.RobotFramework --include smoke src\test\robotframework/
71+
java -cp "target\javafxlibrary-<version>.jar" org.robotframework.RobotFramework --include smoke src\test\robotframework/
7272
```
7373
7474
Linux/OSX command line:
7575
```
76-
java -cp "target/JavaFXLibrary-<version>.jar" org.robotframework.RobotFramework --include smoke src/test/robotframework/
76+
java -cp "target/javafxlibrary-<version>.jar" org.robotframework.RobotFramework --include smoke src/test/robotframework/
7777

7878
```
7979

‎pom.xml

Lines changed: 59 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,17 @@
1919
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
2020
<modelVersion>4.0.0</modelVersion>
2121
<groupId>org.robotframework</groupId>
22-
<artifactId>JavaFXLibrary</artifactId>
22+
<artifactId>javafxlibrary</artifactId>
2323
<packaging>jar</packaging>
2424
<version>0.4.2-SNAPSHOT</version>
2525
<properties>
2626
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
2727
</properties>
2828

29-
<name>JavaFXLibrary</name>
29+
<name>${project.groupId}:${project.artifactId}</name>
3030
<description>JavaFXLibrary for the Robot Framework.</description>
3131
<url>https://github.com/eficode/JavaFXLibrary/</url>
32+
3233
<licenses>
3334
<license>
3435
<name>The Apache Software License, Version 2.0</name>
@@ -37,13 +38,67 @@
3738
<comments>A business-friendly OSS license</comments>
3839
</license>
3940
</licenses>
41+
42+
<developers>
43+
<developer>
44+
<name>Jukka Haavisto</name>
45+
<email>[email protected]</email>
46+
<organization>Eficode</organization>
47+
<organizationUrl>http://www.eficode.com</organizationUrl>
48+
</developer>
49+
<developer>
50+
<name>Sami Pesonen</name>
51+
<email>[email protected]</email>
52+
<organization>Eficode</organization>
53+
<organizationUrl>http://www.eficode.com</organizationUrl>
54+
</developer>
55+
<developer>
56+
<name>Pasi Saikkonen</name>
57+
<email>[email protected]</email>
58+
<organization>Eficode</organization>
59+
<organizationUrl>http://www.eficode.com</organizationUrl>
60+
</developer>
61+
</developers>
62+
4063
<issueManagement>
4164
<system>Github Issues</system>
4265
<url>https://github.com/eficode/JavaFXLibrary/issues</url>
4366
</issueManagement>
4467

68+
<scm>
69+
<connection>scm:git:git://github.com/eficode/JavaFXLibrary.git</connection>
70+
<developerConnection>scm:git:ssh://github.com:eficode/JavaFXLibrary.git</developerConnection>
71+
<url>http://github.com/eficode/JavaFXLibrary/tree/master</url>
72+
</scm>
73+
4574
<build>
4675
<plugins>
76+
<plugin>
77+
<groupId>org.apache.maven.plugins</groupId>
78+
<artifactId>maven-source-plugin</artifactId>
79+
<version>3.0.1</version>
80+
<executions>
81+
<execution>
82+
<id>attach-sources</id>
83+
<goals>
84+
<goal>jar-no-fork</goal>
85+
</goals>
86+
</execution>
87+
</executions>
88+
</plugin>
89+
<plugin>
90+
<groupId>org.apache.maven.plugins</groupId>
91+
<artifactId>maven-javadoc-plugin</artifactId>
92+
<version>3.0.1</version>
93+
<executions>
94+
<execution>
95+
<id>attach-javadocs</id>
96+
<goals>
97+
<goal>jar</goal>
98+
</goals>
99+
</execution>
100+
</executions>
101+
</plugin>
47102
<plugin>
48103
<artifactId>maven-compiler-plugin</artifactId>
49104
<version>3.6.1</version>
@@ -125,7 +180,7 @@
125180
<configuration>
126181
<libdoc>
127182
<outputFile>${project.artifactId}.html</outputFile>
128-
<libraryOrResourceFile>${project.artifactId}</libraryOrResourceFile>
183+
<libraryOrResourceFile>JavaFXLibrary</libraryOrResourceFile>
129184
<version>${project.version}</version>
130185
</libdoc>
131186
</configuration>
@@ -139,7 +194,7 @@
139194
<configuration>
140195
<libdoc>
141196
<outputFile>${project.artifactId}.xml</outputFile>
142-
<libraryOrResourceFile>${project.artifactId}</libraryOrResourceFile>
197+
<libraryOrResourceFile>JavaFXLibrary</libraryOrResourceFile>
143198
<version>${project.version}</version>
144199
</libdoc>
145200
</configuration>

‎src/main/java/JavaFXLibrary.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,7 @@ public Object runKeyword(String keywordName, Object[] args) {
9191
public String getKeywordDocumentation(String keywordName) {
9292
if (keywordName.equals("__intro__")) {
9393
try {
94-
return FileUtils.readFileToString(new File("libdoc-documentation.txt"), "utf-8");
94+
return FileUtils.readFileToString(new File("./src/main/java/libdoc-documentation.txt"), "utf-8");
9595
} catch (IOException e) {
9696
e.printStackTrace();
9797
return "IOException occured while reading the documentation file!";

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ First, the JavaFXLibrary needs to be taken into use in the settings table.
2424

2525
=== 2.2 Usage in remote mode(Jython & Python) ===
2626
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:
27-
- _java -jar JavaFXLibrary-<version>.jar_
27+
- _java -jar javafxlibrary-<version>.jar_
2828
This will start the remote server listening at default port number 8270.
2929

3030
If there is a need to use a different port the library can be started with optional parameter:
31-
- _java -jar JavaFXLibrary-<version>.jar 1234_
31+
- _java -jar javafxlibrary-<version>.jar 1234_
3232
This will start the remote server listening on port 1234.
3333

3434
JavaFXLibrary can be taken into use as remote library in settings table as follows:

0 commit comments

Comments
 (0)