From 4f0460a7e8adda9a8576cf4df1e9ab8abadff9ce Mon Sep 17 00:00:00 2001 From: Jonas Schaub <44881147+JonasSchaub@users.noreply.github.com> Date: Thu, 2 Nov 2023 15:47:36 +0100 Subject: [PATCH] Added javadoc publication action file and preparations for v1.4 release; --- .github/workflows/publish-javadoc.yml | 25 +++++++++++++++++++ CITATION.cff | 2 +- .../Usage instructions.txt | 2 +- pom.xml | 2 +- .../unijena/cheminf/deglycosylation/Main.java | 2 +- .../SugarRemovalUtilityCmdApplication.java | 2 +- 6 files changed, 30 insertions(+), 5 deletions(-) create mode 100644 .github/workflows/publish-javadoc.yml diff --git a/.github/workflows/publish-javadoc.yml b/.github/workflows/publish-javadoc.yml new file mode 100644 index 0000000..a71cb47 --- /dev/null +++ b/.github/workflows/publish-javadoc.yml @@ -0,0 +1,25 @@ +name: Deploy Javadoc + +#Note: The Javadoc-publisher action only commits to javadoc branch and triggers the GitHub pages update action if there +# are changes in the JavaDoc, i.e. it ignores the Readme.md that is used as main landing page of the GitHub pages! +# And these need to be merged into the javadoc branch. + +on: + release: + types: [published] #alternatives: released, published, created + #push: + #branches: + #- main + +jobs: + publish: + runs-on: ubuntu-latest + steps: + - name: Deploy JavaDoc 🚀 + uses: MathieuSoysal/Javadoc-publisher.yml@v2.4.0 + with: + GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}} + javadoc-branch: javadoc + java-version: 17 + target-folder: javadoc/1.4 + project: maven diff --git a/CITATION.cff b/CITATION.cff index c6d4b57..2071a4a 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -1,6 +1,6 @@ cff-version: 1.2.0 title: Sugar Removal Utility (SRU) -version: 1.3.2.0 +version: 1.4.0.0 message: "If you use this software, please cite it as below and also cite the accompanying scientific publication referenced below." type: software authors: diff --git a/SugarRemovalUtility CMD App/Usage instructions.txt b/SugarRemovalUtility CMD App/Usage instructions.txt index 5044a75..f7a0a3b 100644 --- a/SugarRemovalUtility CMD App/Usage instructions.txt +++ b/SugarRemovalUtility CMD App/Usage instructions.txt @@ -21,7 +21,7 @@ The output file and a log file will be created in the same directory as the inpu To run the application, execute the supplied executable JAR file from the command line, using the 'java -jar' command (see example usages at the end of this document). -Java version 11 or higher needs to be installed on your machine. +Java version 17 or higher needs to be installed on your machine. Also, multiple command line arguments/options are available (some optional, some required) when executing the JAR file. These are (-[short name] --[long name] ): diff --git a/pom.xml b/pom.xml index 9fa88e9..5d23169 100644 --- a/pom.xml +++ b/pom.xml @@ -30,7 +30,7 @@ de.unijena.cheminf sugarremovalutility - 1.3.2.1 + 1.4.0.0 Sugar Removal Utility diff --git a/src/main/java/de/unijena/cheminf/deglycosylation/Main.java b/src/main/java/de/unijena/cheminf/deglycosylation/Main.java index d001352..8d75978 100644 --- a/src/main/java/de/unijena/cheminf/deglycosylation/Main.java +++ b/src/main/java/de/unijena/cheminf/deglycosylation/Main.java @@ -38,7 +38,7 @@ public class Main { /** * Instantiates the SugarRemovalUtilityCmdApplication class and calls its execute() method. - * This method also tests the Java version (must be version 11.0.5 or higher) and measures the time it takes to + * This method also tests the Java version (must be version 17.0.4 or higher) and measures the time it takes to * execute the application. The command-line arguments (args) are not parsed or tested here but passed on to the * SugarRemovalUtilityCmdApplication class constructor. Outputs are written to System.out and System.err if * anything goes wrong. Exceptions are not thrown. The system is exited if an error occurs or the application is diff --git a/src/main/java/de/unijena/cheminf/deglycosylation/SugarRemovalUtilityCmdApplication.java b/src/main/java/de/unijena/cheminf/deglycosylation/SugarRemovalUtilityCmdApplication.java index f49947f..87f0fdb 100644 --- a/src/main/java/de/unijena/cheminf/deglycosylation/SugarRemovalUtilityCmdApplication.java +++ b/src/main/java/de/unijena/cheminf/deglycosylation/SugarRemovalUtilityCmdApplication.java @@ -78,7 +78,7 @@ public class SugarRemovalUtilityCmdApplication { /** * Version string of this class to print out if -v --version is queried from the command-line. */ - public static final String VERSION = "1.3.2.0"; + public static final String VERSION = "1.4.0.0"; // // //