From ffe55884ad5b14eabd90f93b3b9b4ede21873a2b Mon Sep 17 00:00:00 2001 From: "Vincent A. Cicirello" Date: Fri, 18 Sep 2020 14:35:56 -0400 Subject: [PATCH 1/2] Modernized javadocs to html5 Upgraded build to JDK11, but still targeting Java 8. Purpose is to use the JDK11 javadoc to modernize documentation, such as with search and no frames. --- .github/workflows/maven-publish.yml | 8 +- pom.xml | 462 ++++++++++++++-------------- 2 files changed, 243 insertions(+), 227 deletions(-) diff --git a/.github/workflows/maven-publish.yml b/.github/workflows/maven-publish.yml index e7451288..29dac655 100644 --- a/.github/workflows/maven-publish.yml +++ b/.github/workflows/maven-publish.yml @@ -19,10 +19,10 @@ jobs: id: get_version run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\/v/} - - name: Set up JDK 1.8 for deploy to OSSRH + - name: Set up JDK 11 for deploy to OSSRH uses: actions/setup-java@v1 with: - java-version: 1.8 + java-version: 1.11 server-id: ossrh server-username: MAVEN_USERNAME server-password: MAVEN_CENTRAL_TOKEN @@ -42,10 +42,10 @@ jobs: MAVEN_CENTRAL_TOKEN: ${{ secrets.MAVEN_CENTRAL_TOKEN }} MAVEN_GPG_PASSPHRASE: ${{ secrets.MAVEN_GPG_PASSPHRASE }} - - name: Set up JDK 1.8 for deploy to github packages + - name: Set up JDK 11 for deploy to github packages uses: actions/setup-java@v1 with: - java-version: 1.8 + java-version: 1.11 server-id: github - name: Publish to GitHub Packages Apache Maven diff --git a/pom.xml b/pom.xml index 7c10f2a4..e464a223 100644 --- a/pom.xml +++ b/pom.xml @@ -1,243 +1,259 @@ + http://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 - org.cicirello - jpt - 2.1.0 - jar + org.cicirello + jpt + 2.1.0 + jar - JavaPermutationTools - JavaPermutationTools (JPT) is a library for - computation on permutations and sequences. - JPT provides Java classes that enable representing and - generating permutations and sequences, as well as - performing computation on permutations and sequences. - It includes implementations of a variety of permutation - distance metrics as well as distance metrics on sequences - (i.e., Strings, arrays, and other ordered data types). - https://jpt.cicirello.org/ - - - - GPL-3.0-or-later - https://www.gnu.org/licenses/gpl-3.0.en.html - repo - - JavaPermutationTools (JPT): A library for computation on permutations and sequences. - Copyright (C) 2005-2020 Vincent A. Cicirello. + JavaPermutationTools + JavaPermutationTools (JPT) is a library for + computation on permutations and sequences. + JPT provides Java classes that enable representing and + generating permutations and sequences, as well as + performing computation on permutations and sequences. + It includes implementations of a variety of permutation + distance metrics as well as distance metrics on sequences + (i.e., Strings, arrays, and other ordered data types). + https://jpt.cicirello.org/ - JavaPermutationTools is free software: you can redistribute it and/or modify - it under the terms of the GNU General Public License as published by - the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. + + + GPL-3.0-or-later + https://www.gnu.org/licenses/gpl-3.0.en.html + repo + + JavaPermutationTools (JPT): A library for computation on permutations and sequences. + Copyright (C) 2005-2020 Vincent A. Cicirello. - JavaPermutationTools is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU General Public License for more details. + JavaPermutationTools is free software: you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. - You should have received a copy of the GNU General Public License - along with this program. If not, see https://www.gnu.org/licenses/. - - - - - - - Vincent A Cicirello - development@cicirello.org - https://www.cicirello.org/ - Cicirello.Org - https://www.cicirello.org/ - - + JavaPermutationTools is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. - - Cicirello.Org - https://www.cicirello.org/ - + You should have received a copy of the GNU General Public License + along with this program. If not, see https://www.gnu.org/licenses/. + + + - - - ossrhDeploy - - - ossrh - Central Repository OSSRH - https://oss.sonatype.org/service/local/staging/deploy/maven2/ - - - ossrh - Central Repository OSSRH - https://oss.sonatype.org/content/repositories/snapshots - - - - - - org.apache.maven.plugins - maven-gpg-plugin - 1.6 - - - sign-artifacts - verify - - sign - - - - --pinentry-mode - loopback - - - - - - - - - - githubDeploy - - - github - GitHub cicirello Apache Maven Packages - https://maven.pkg.github.com/cicirello/JavaPermutationTools - - - - + + + Vincent A Cicirello + development@cicirello.org + https://www.cicirello.org/ + Cicirello.Org + https://www.cicirello.org/ + + + + + Cicirello.Org + https://www.cicirello.org/ + - - github - https://github.com/cicirello/JavaPermutationTools/issues - + + + ossrhDeploy + + + ossrh + Central Repository OSSRH + https://oss.sonatype.org/service/local/staging/deploy/maven2/ + + + ossrh + Central Repository OSSRH + https://oss.sonatype.org/content/repositories/snapshots + + + + + + org.apache.maven.plugins + maven-gpg-plugin + 1.6 + + + sign-artifacts + verify + + sign + + + + --pinentry-mode + loopback + + + + + + + + + + githubDeploy + + + github + GitHub cicirello Apache Maven Packages + https://maven.pkg.github.com/cicirello/JavaPermutationTools + + + + - - scm:git:git://github.com/cicirello/JavaPermutationTools.git - scm:git:ssh://github.com:cicirello/JavaPermutationTools.git - http://github.com/cicirello/JavaPermutationTools/tree/master - + + github + https://github.com/cicirello/JavaPermutationTools/issues + + + scm:git:git://github.com/cicirello/JavaPermutationTools.git + scm:git:ssh://github.com:cicirello/JavaPermutationTools.git + http://github.com/cicirello/JavaPermutationTools/tree/master + - - - junit - junit - 4.13 - jar - test - true - - + + + junit + junit + 4.13 + jar + test + true + + - - UTF-8 - 1.8 - 1.8 - + + UTF-8 + 1.8 + 1.8 + - - ${project.basedir}/dist - ${project.basedir}/bin - ${project.artifactId}-${project.version} - ${project.basedir}/testbin - ${project.basedir}/src - ${project.basedir}/src/scripts - ${project.basedir}/tests - - - ${project.basedir}/src/resources - - - - - ${project.basedir}/tests/resources - - - - - org.apache.maven.plugins - maven-source-plugin - 3.2.1 - - - attach-sources - - jar - - - - - - org.apache.maven.plugins - maven-javadoc-plugin - 3.2.0 - - - attach-javadocs - - jar - - - - - JavaPermutationTools - A Java API for computation on permutations - JavaPermutationTools - A Java API for computation on permutations - false - false - ${project.build.sourceDirectory}/overview.html - true - - https://docs.oracle.com/javase/8/docs/api - - Vincent A. Cicirello. All rights reserved.]]> - - - - org.apache.maven.plugins - maven-surefire-plugin - 3.0.0-M5 - - - **/*TestCases.java - **/*Tests.java - **/*TestCase.java - **/*Test.java - **/Test*.java - - - - - + + ${project.basedir}/dist + ${project.basedir}/bin + ${project.artifactId}-${project.version} + ${project.basedir}/testbin + ${project.basedir}/src + ${project.basedir}/src/scripts + ${project.basedir}/tests + + + ${project.basedir}/src/resources + + + + + ${project.basedir}/tests/resources + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.8.1 + + 1.8 + 1.8 + + + + org.apache.maven.plugins + maven-source-plugin + 3.2.1 + + + attach-sources + + jar + + + + + + org.apache.maven.plugins + maven-javadoc-plugin + 3.2.0 + + + attach-javadocs + + jar + + + + + 1.8 + + --no-module-directories + + JavaPermutationTools - A Java API for computation on permutations + JavaPermutationTools - A Java API for computation on permutations + false + false + ${project.build.sourceDirectory}/overview.html + true + + https://docs.oracle.com/javase/8/docs/api + + Vincent A. Cicirello. All rights reserved.]]> + + + + org.apache.maven.plugins + maven-surefire-plugin + 3.0.0-M5 + + + **/*TestCases.java + **/*Tests.java + **/*TestCase.java + **/*Test.java + **/Test*.java + + + + + - - - - org.apache.maven.plugins - maven-javadoc-plugin - 3.2.0 - - ${project.basedir}/docs/api - api - ${project.basedir}/docs/api - JavaPermutationTools - A Java API for computation on permutations - JavaPermutationTools - A Java API for computation on permutations - false - false - ${project.build.sourceDirectory}/overview.html - true - - https://docs.oracle.com/javase/8/docs/api - - Vincent A. Cicirello. All rights reserved.]]> - - - - + + + + org.apache.maven.plugins + maven-javadoc-plugin + 3.2.0 + + 1.8 + + --no-module-directories + + ${project.basedir}/docs/api + api + ${project.basedir}/docs/api + JavaPermutationTools - A Java API for computation on permutations + JavaPermutationTools - A Java API for computation on permutations + false + false + ${project.build.sourceDirectory}/overview.html + true + + https://docs.oracle.com/javase/8/docs/api + + Vincent A. Cicirello. All rights reserved.]]> + + + + From e42f33509e48551930896ceebbd9352e2106a5b7 Mon Sep 17 00:00:00 2001 From: "Vincent A. Cicirello" Date: Fri, 18 Sep 2020 14:42:12 -0400 Subject: [PATCH 2/2] Create manual-deploy.yml Added a maunally triggered workflow for deploying a package to Github Packages. --- .github/workflows/manual-deploy.yml | 37 +++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 .github/workflows/manual-deploy.yml diff --git a/.github/workflows/manual-deploy.yml b/.github/workflows/manual-deploy.yml new file mode 100644 index 00000000..f473ce91 --- /dev/null +++ b/.github/workflows/manual-deploy.yml @@ -0,0 +1,37 @@ +name: Manual Maven Deploy Package + +on: + workflow_dispatch: + inputs: + VERSION: + description: 'The SemVer version number' + required: true + +jobs: + build: + + runs-on: ubuntu-latest + + env: + artifact_name: jpt + + steps: + - uses: actions/checkout@v2 + - name: Set up JDK 11 + uses: actions/setup-java@v1 + with: + java-version: 1.11 + server-id: github + + - name: Build with Maven + run: mvn -B package --file pom.xml + + - name: Update package version + run: mvn versions:set -DnewVersion=${{ github.event.inputs.VERSION }} + + - name: Publish to GitHub Packages Apache Maven + run: mvn deploy -PgithubDeploy + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + +