Skip to content

Commit

Permalink
Added javadoc publication action file and preparations for v1.4 release;
Browse files Browse the repository at this point in the history
  • Loading branch information
JonasSchaub committed Nov 2, 2023
1 parent 142b780 commit 4f0460a
Show file tree
Hide file tree
Showing 6 changed files with 30 additions and 5 deletions.
25 changes: 25 additions & 0 deletions .github/workflows/publish-javadoc.yml
Original file line number Diff line number Diff line change
@@ -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/[email protected]
with:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
javadoc-branch: javadoc
java-version: 17
target-folder: javadoc/1.4
project: maven
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
@@ -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:
Expand Down
2 changes: 1 addition & 1 deletion SugarRemovalUtility CMD App/Usage instructions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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] <argument>):
Expand Down
2 changes: 1 addition & 1 deletion pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

<groupId>de.unijena.cheminf</groupId>
<artifactId>sugarremovalutility</artifactId>
<version>1.3.2.1</version>
<version>1.4.0.0</version>
<name>Sugar Removal Utility</name>

<properties>
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/de/unijena/cheminf/deglycosylation/Main.java
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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";
//</editor-fold>
//
//<editor-fold desc="Private static final constants">
Expand Down

0 comments on commit 4f0460a

Please sign in to comment.