From 3b761400979e8f3c2781b2647d6bf1e10609ba59 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Tue, 21 Feb 2023 14:15:38 +0100 Subject: [PATCH 01/32] validate CFF File --- CITATION.cff | 1 - 1 file changed, 1 deletion(-) diff --git a/CITATION.cff b/CITATION.cff index b523397..03dd964 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -27,6 +27,5 @@ authors: given-names: "Anne" title: "TEIGarage" version: 1.0.0 -doi: date-released: 2022-09-14 url: "https://github.com/TEIC/TEIGarage" From d7e59f577b7e662be1bb1b3824b66561deccd3d1 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Wed, 1 Mar 2023 13:08:21 +0100 Subject: [PATCH 02/32] Create fair-software.yml --- .github/workflows/fair-software.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .github/workflows/fair-software.yml diff --git a/.github/workflows/fair-software.yml b/.github/workflows/fair-software.yml new file mode 100644 index 0000000..d1fa0a4 --- /dev/null +++ b/.github/workflows/fair-software.yml @@ -0,0 +1,15 @@ +name: fair-software + +on: push + +jobs: + verify: + name: "fair-software" + runs-on: ubuntu-latest + steps: + - uses: fair-software/howfairis-github-action@0.2.1 + name: Measure compliance with fair-software.eu recommendations + env: + PYCHARM_HOSTED: "Trick colorama into displaying colored output" + with: + MY_REPO_URL: "https://github.com/${{ github.repository }}" From 1ea94abbd711049c3de1e6232805df71dbc38bbb Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Wed, 1 Mar 2023 13:09:39 +0100 Subject: [PATCH 03/32] Create codeql.yml --- .github/workflows/codeql.yml | 80 ++++++++++++++++++++++++++++++++++++ 1 file changed, 80 insertions(+) create mode 100644 .github/workflows/codeql.yml diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml new file mode 100644 index 0000000..944554b --- /dev/null +++ b/.github/workflows/codeql.yml @@ -0,0 +1,80 @@ +# For most projects, this workflow file will not need changing; you simply need +# to commit it to your repository. +# +# You may wish to alter this file to override the set of languages analyzed, +# or to provide custom queries or build logic. +# +# ******** NOTE ******** +# We have attempted to detect the languages in your repository. Please check +# the `language` matrix defined below to confirm you have the correct set of +# supported CodeQL languages. +# +name: "CodeQL" + +on: + push: + branches: [ "dev", main ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ "dev" ] + schedule: + - cron: '28 18 * * 0' + +jobs: + analyze: + name: Analyze + runs-on: ubuntu-latest + permissions: + actions: read + contents: read + security-events: write + + strategy: + fail-fast: false + matrix: + language: [ 'java' ] + # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] + # Use only 'java' to analyze code written in Java, Kotlin or both + # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both + # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support + + steps: + - name: Checkout repository + uses: actions/checkout@v3 + + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. + + # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality + + - name: maven-settings + uses: s4u/maven-settings-action@v2.7.0 + with: + servers: '[{"id": "teic", "username": "${github.actor}", "password": "${GITHUB_TOKEN}"}]' + + # Autobuild attempts to build any compiled languages (C/C++, C#, Go, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + #- name: Autobuild + # uses: github/codeql-action/autobuild@v2 + + # ℹī¸ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + + # If the Autobuild fails above, remove it and uncomment the following three lines. + # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. + - name: Build with Maven + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + run: mvn clean package --file pom.xml + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 + with: + category: "/language:${{matrix.language}}" From b307b73eca353afdc3b4aba8a01f730606bad3e2 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Wed, 1 Mar 2023 13:14:44 +0100 Subject: [PATCH 04/32] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index abac302..017404b 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [![GitHub license](https://img.shields.io/github/license/teic/TEIGarage.svg)](https://github.com/TEIC/TEIGarage/blob/main/LICENSE) [![GitHub release](https://img.shields.io/github/v/release/TEIC/TEIGarage.svg)](https://github.com/TEIC/TEIGarage/releases) [![Docker](https://img.shields.io/docker/pulls/teic/teigarage)](https://hub.docker.com/r/teic/teigarage) -[![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8B-yellow)](https://fair-software.eu) +[![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6925/badge)](https://bestpractices.coreinfrastructure.org/projects/6925) From bf03cdd76051e01971ff841795858232f5b6ee5c Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Mon, 22 May 2023 14:56:22 +0200 Subject: [PATCH 05/32] updated docker file refs #42 --- Dockerfile | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index 5064698..ae57523 100644 --- a/Dockerfile +++ b/Dockerfile @@ -56,8 +56,9 @@ COPY log4j.xml /var/cache/oxgarage/log4j.xml # download artifacts to /tmp and deploy them at ${CATALINA_WEBAPPS} # these war-files are zipped so we need to unzip them twice -#conditional copy in docker needs a strange hack -COPY log4j.xml artifact/teigarage.wa[r] /tmp/ +# conditional copy in docker needs a strange hack +# docker behavior on this changed, hack is not needed anymore +COPY artifac[t]/teigarage.wa[r] /tmp/ RUN if [ "$BUILDTYPE" = "local" ] ; then \ curl -Ls ${WEBSERVICE_ARTIFACT} -o /tmp/teigarage.zip \ From aa22f0c3f819ed178b8cfc04b9e010e26dbc1c81 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Mon, 22 May 2023 15:14:13 +0200 Subject: [PATCH 06/32] update tomcat image refs #43 --- Dockerfile | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index ae57523..ad6731f 100644 --- a/Dockerfile +++ b/Dockerfile @@ -5,7 +5,7 @@ # of both the ege-webclient and the TEIGarage (backend), # and installs it in a Tomcat application server ######################################### -FROM tomcat:9-jdk11-openjdk +FROM tomcat:9-jdk11 LABEL org.opencontainers.image.source=https://github.com/teic/teigarage @@ -36,6 +36,7 @@ RUN apt-get update \ libgcc-10-dev \ librsvg2-bin \ curl \ + unzip \ && ln -s ${OFFICE_HOME} /usr/lib/openoffice \ && rm -rf /var/lib/apt/lists/* From 9f0846065daab574c8ec15ae4813a38bb61d58c5 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Tue, 23 May 2023 11:08:09 +0200 Subject: [PATCH 07/32] make Dockerfile clearer on local and github build --- Dockerfile | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/Dockerfile b/Dockerfile index ad6731f..aaabf49 100644 --- a/Dockerfile +++ b/Dockerfile @@ -56,16 +56,22 @@ COPY log4j.xml /var/cache/oxgarage/log4j.xml # && unzip /tmp/webservice.zip -d /tmp/ # download artifacts to /tmp and deploy them at ${CATALINA_WEBAPPS} -# these war-files are zipped so we need to unzip them twice -# conditional copy in docker needs a strange hack -# docker behavior on this changed, hack is not needed anymore -COPY artifac[t]/teigarage.wa[r] /tmp/ + +# if the action is run on github, the war is already located in the artifact folder because of the previous github action +RUN if [ "$BUILDTYPE" = "github" ] ; then \ + cp artifact/teigarage.war /tmp/; \ + fi + +# if docker build is local the latest artifact needs to be downloaded using the nightly link url RUN if [ "$BUILDTYPE" = "local" ] ; then \ curl -Ls ${WEBSERVICE_ARTIFACT} -o /tmp/teigarage.zip \ && unzip -o -q /tmp/teigarage.zip -d /tmp/; \ - fi \ - && unzip -q /tmp/teigarage.war -d ${CATALINA_WEBAPPS}/ege-webservice/ \ + fi + +# these war-files are zipped so we need to unzip them twice +# the GUI/webclient needs to be downloaded locally and on github +RUN unzip -q /tmp/teigarage.war -d ${CATALINA_WEBAPPS}/ege-webservice/ \ && rm -Rf ${CATALINA_WEBAPPS}/ROOT \ && curl -Ls ${WEBCLIENT_ARTIFACT} -o /tmp/webclient.zip \ && unzip -q /tmp/webclient.zip -d /tmp/ \ From 5f4aba865b755cc5c3ae0e420d4c533933583575 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Tue, 23 May 2023 11:30:06 +0200 Subject: [PATCH 08/32] using absolute path in Dockerfile --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index aaabf49..b00716a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -60,7 +60,7 @@ COPY log4j.xml /var/cache/oxgarage/log4j.xml # if the action is run on github, the war is already located in the artifact folder because of the previous github action RUN if [ "$BUILDTYPE" = "github" ] ; then \ - cp artifact/teigarage.war /tmp/; \ + cp /home/runner/work/TEIGarage/TEIGarage/artifact/teigarage.war /tmp/; \ fi # if docker build is local the latest artifact needs to be downloaded using the nightly link url From 7d32ac24cc50cec7ec40c675b26fdce12b9a16f2 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Tue, 23 May 2023 11:39:12 +0200 Subject: [PATCH 09/32] changing artifact path --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index b00716a..aa1c443 100644 --- a/Dockerfile +++ b/Dockerfile @@ -60,7 +60,7 @@ COPY log4j.xml /var/cache/oxgarage/log4j.xml # if the action is run on github, the war is already located in the artifact folder because of the previous github action RUN if [ "$BUILDTYPE" = "github" ] ; then \ - cp /home/runner/work/TEIGarage/TEIGarage/artifact/teigarage.war /tmp/; \ + cp /home/runner/work/TEIGarage/TEIGarage/artifact/artifact/teigarage.war /tmp/; \ fi # if docker build is local the latest artifact needs to be downloaded using the nightly link url From 193ca028d83559f177b396e741928cb197958dc8 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Tue, 23 May 2023 11:50:41 +0200 Subject: [PATCH 10/32] docker copy file --- Dockerfile | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/Dockerfile b/Dockerfile index aa1c443..457d792 100644 --- a/Dockerfile +++ b/Dockerfile @@ -57,12 +57,13 @@ COPY log4j.xml /var/cache/oxgarage/log4j.xml # download artifacts to /tmp and deploy them at ${CATALINA_WEBAPPS} - +COPY artifact/teigarage.war /tmp/ # if the action is run on github, the war is already located in the artifact folder because of the previous github action RUN if [ "$BUILDTYPE" = "github" ] ; then \ - cp /home/runner/work/TEIGarage/TEIGarage/artifact/artifact/teigarage.war /tmp/; \ + cp /home/runner/work/TEIGarage/TEIGarage/artifact/teigarage.war /tmp/; \ fi + # if docker build is local the latest artifact needs to be downloaded using the nightly link url RUN if [ "$BUILDTYPE" = "local" ] ; then \ curl -Ls ${WEBSERVICE_ARTIFACT} -o /tmp/teigarage.zip \ From 599884efd713f9eabaeacaa69e5d593283040ded Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Tue, 23 May 2023 12:00:07 +0200 Subject: [PATCH 11/32] relative path again --- Dockerfile | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 457d792..f7a9775 100644 --- a/Dockerfile +++ b/Dockerfile @@ -60,7 +60,7 @@ COPY log4j.xml /var/cache/oxgarage/log4j.xml COPY artifact/teigarage.war /tmp/ # if the action is run on github, the war is already located in the artifact folder because of the previous github action RUN if [ "$BUILDTYPE" = "github" ] ; then \ - cp /home/runner/work/TEIGarage/TEIGarage/artifact/teigarage.war /tmp/; \ + cp artifact/teigarage.war /tmp/ ; \ fi From cc7164f10e8ccec97c419d20b96cec633c1532a6 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Tue, 23 May 2023 14:11:38 +0200 Subject: [PATCH 12/32] use strange conditional copy hack again --- Dockerfile | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/Dockerfile b/Dockerfile index f7a9775..bb63c0e 100644 --- a/Dockerfile +++ b/Dockerfile @@ -57,12 +57,12 @@ COPY log4j.xml /var/cache/oxgarage/log4j.xml # download artifacts to /tmp and deploy them at ${CATALINA_WEBAPPS} -COPY artifact/teigarage.war /tmp/ -# if the action is run on github, the war is already located in the artifact folder because of the previous github action -RUN if [ "$BUILDTYPE" = "github" ] ; then \ - cp artifact/teigarage.war /tmp/ ; \ - fi +# if the action is run on github, the war is already located in the artifact folder because of the previous github action +#RUN if [ "$BUILDTYPE" = "github" ] ; then \ +# cp artifact/teigarage.war /tmp/ ; \ +# fi +COPY artifac[t]/teigarage.wa[r] /tmp/ # if docker build is local the latest artifact needs to be downloaded using the nightly link url RUN if [ "$BUILDTYPE" = "local" ] ; then \ From b34359fdd86f7d46d9f2e59bfea9ae51d5dfd3ea Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Thu, 1 Jun 2023 16:31:53 +0200 Subject: [PATCH 13/32] add PMD check and remove unused variables --- pom.xml | 18 +++++++++++ .../ege/webapp/servlet/ConversionServlet.java | 30 ------------------- .../webapp/servlet/CustomizationServlet.java | 5 ---- .../ege/webapp/servlet/ValidationServlet.java | 4 --- 4 files changed, 18 insertions(+), 39 deletions(-) diff --git a/pom.xml b/pom.xml index 6d8471a..e7a2d6d 100644 --- a/pom.xml +++ b/pom.xml @@ -159,6 +159,24 @@ ${project.artifactId}-${project.version} --> + + org.apache.maven.plugins + maven-pmd-plugin + 3.13.0 + + false + true + false + + + + compile + + check + + + + diff --git a/src/main/java/pl/psnc/dl/ege/webapp/servlet/ConversionServlet.java b/src/main/java/pl/psnc/dl/ege/webapp/servlet/ConversionServlet.java index fb7fc4b..58bc43c 100644 --- a/src/main/java/pl/psnc/dl/ege/webapp/servlet/ConversionServlet.java +++ b/src/main/java/pl/psnc/dl/ege/webapp/servlet/ConversionServlet.java @@ -10,7 +10,6 @@ import javax.ws.rs.GET; import javax.ws.rs.POST; import javax.ws.rs.Path; -import javax.ws.rs.PathParam; import io.swagger.v3.oas.annotations.ExternalDocumentation; @@ -26,8 +25,6 @@ import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.tags.Tag; -import org.apache.logging.log4j.Logger; -import org.apache.logging.log4j.LogManager; import org.json.XML; @@ -57,24 +54,6 @@ ) public class ConversionServlet extends HttpServlet { - private static final String imagesDirectory = "media"; - - private static final String EZP_EXT = ".ezp"; - - private static final String FORMAT_DOCX = "docx"; - - private static final String FORMAT_ODT = "oo"; - - private static final String APPLICATION_MSWORD = "application/msword"; - - private static final String APPLICATION_EPUB = "application/epub+zip"; - - private static final String APPLICATION_ODT = "application/vnd.oasis.opendocument.text"; - - private static final String APPLICATION_OCTET_STREAM = "application/octet-stream"; - - private static final Logger LOGGER = LogManager.getLogger(ConversionServlet.class); - private static final long serialVersionUID = 1L; public static final String SLASH = "/"; @@ -83,16 +62,8 @@ public class ConversionServlet extends HttpServlet { public static final String SEMICOLON = ";"; - public static final String R_WRONG_METHOD = "Wrong method: GET, expected: POST."; - public static final String CONVERSIONS_SLICE_BASE = "Conversions/"; - public static final String ZIP_EXT = ".zip"; - - public static final String DOCX_EXT = ".docx"; - - public static final String EPUB_EXT = ".epub"; - public static final String ODT_EXT = ".odt"; Conversion conversion; @@ -102,7 +73,6 @@ public class ConversionServlet extends HttpServlet { */ public ConversionServlet() { super(); - Conversion conversion = new Conversion(); } /** diff --git a/src/main/java/pl/psnc/dl/ege/webapp/servlet/CustomizationServlet.java b/src/main/java/pl/psnc/dl/ege/webapp/servlet/CustomizationServlet.java index 03abb83..ef95fa6 100644 --- a/src/main/java/pl/psnc/dl/ege/webapp/servlet/CustomizationServlet.java +++ b/src/main/java/pl/psnc/dl/ege/webapp/servlet/CustomizationServlet.java @@ -8,8 +8,6 @@ import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.tags.Tag; -import org.apache.logging.log4j.Logger; -import org.apache.logging.log4j.LogManager; import org.json.XML; import pl.psnc.dl.ege.webapp.servlethelpers.Customization; @@ -28,9 +26,6 @@ }) public class CustomizationServlet extends HttpServlet { - private static final Logger LOGGER = LogManager - .getLogger(CustomizationServlet.class); - private static final long serialVersionUID = 1L; Customization customization = new Customization(); diff --git a/src/main/java/pl/psnc/dl/ege/webapp/servlet/ValidationServlet.java b/src/main/java/pl/psnc/dl/ege/webapp/servlet/ValidationServlet.java index 562fc38..bc819b1 100644 --- a/src/main/java/pl/psnc/dl/ege/webapp/servlet/ValidationServlet.java +++ b/src/main/java/pl/psnc/dl/ege/webapp/servlet/ValidationServlet.java @@ -18,8 +18,6 @@ import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.tags.Tag; -import org.apache.logging.log4j.Logger; -import org.apache.logging.log4j.LogManager; import pl.psnc.dl.ege.types.DataType; @@ -37,8 +35,6 @@ public class ValidationServlet extends HttpServlet { - private static final Logger LOGGER = LogManager - .getLogger(ValidationServlet.class); private static final long serialVersionUID = 1L; From bb9693c2325b3549d0b8e5fe4ee1f07d9675f26a Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Fri, 2 Jun 2023 10:29:13 +0200 Subject: [PATCH 14/32] Create dependabot.yml --- .github/dependabot.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..d4cd657 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates + +version: 2 +updates: + - package-ecosystem: "maven" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "weekly" From 6bac6f6b1ae537b33f7ea6a321bbf1b8b69489c4 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 2 Jun 2023 08:29:34 +0000 Subject: [PATCH 15/32] Bump maven-pmd-plugin from 3.13.0 to 3.21.0 Bumps [maven-pmd-plugin](https://github.com/apache/maven-pmd-plugin) from 3.13.0 to 3.21.0. - [Release notes](https://github.com/apache/maven-pmd-plugin/releases) - [Commits](https://github.com/apache/maven-pmd-plugin/compare/maven-pmd-plugin-3.13.0...maven-pmd-plugin-3.21.0) --- updated-dependencies: - dependency-name: org.apache.maven.plugins:maven-pmd-plugin dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index e7a2d6d..049f78d 100644 --- a/pom.xml +++ b/pom.xml @@ -162,7 +162,7 @@ org.apache.maven.plugins maven-pmd-plugin - 3.13.0 + 3.21.0 false true From a65823df5cb60dff76af803d7d79f28c1f93edbf Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 2 Jun 2023 08:29:44 +0000 Subject: [PATCH 16/32] Bump javax.ws.rs-api from 2.1 to 2.1.1 Bumps [javax.ws.rs-api](https://github.com/eclipse-ee4j/jaxrs-api) from 2.1 to 2.1.1. - [Release notes](https://github.com/eclipse-ee4j/jaxrs-api/releases) - [Changelog](https://github.com/jakartaee/rest/blob/master/jaxrs-tck-docs/JAXRSTCK3.1-ReleaseNotes.html) - [Commits](https://github.com/eclipse-ee4j/jaxrs-api/commits/2.1.1) --- updated-dependencies: - dependency-name: javax.ws.rs:javax.ws.rs-api dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index e7a2d6d..9bc66c9 100644 --- a/pom.xml +++ b/pom.xml @@ -200,7 +200,7 @@ javax.ws.rs javax.ws.rs-api - 2.1 + 2.1.1 pl.psnc.dl.ege From 9de5a8e07f3e3c5e3928c5c44f912fefaa7b99af Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Fri, 2 Jun 2023 11:36:22 +0200 Subject: [PATCH 17/32] Update README.md --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 017404b..51a9ad0 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,13 @@ ## Table of Contents * [About the Project](#about) +* [How to use](#how-to-use) * [Installation](#installation) * [With Docker](#installing-with-docker) * [Without Docker](#installing-without-docker) * [Building with Maven](#building-with-maven) + # About TEIGarage is a webservice and RESTful service to transform, convert and validate various formats, focussing on the [TEI](https://tei-c.org/) format. @@ -25,6 +27,14 @@ Further information on the **code structure** of MEIGarage and TEIGarage can be A running instance of TEIGarage can be found at [teigarage.tei-c.org](https://teigarage.tei-c.org/). +# How to use + +Open API documentation can be found at https://github.com/TEIC/TEIGarage/blob/main/src/main/webapp/openapi.json or at the running instance https://teigarage.tei-c.org/ege-webservice/. A curl example call to the API to convert an existing .docx to a TEI file looks like + +``` +curl -o output.xml -F upload=@input.docx https://teigarage.tei-c.org/ege-webservice/Conversions/docx%3Aapplication%3Avnd.openxmlformats-officedocument.wordprocessingml.document/TEI%3Atext%3Axml/ +``` + # Installation ## Installing with Docker From f0e31e8ffd222c403437abc32fca41c000f717b1 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Fri, 23 Jun 2023 12:45:31 +0200 Subject: [PATCH 18/32] Update README.md --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 51a9ad0..0fa125a 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ [![Docker](https://img.shields.io/docker/pulls/teic/teigarage)](https://hub.docker.com/r/teic/teigarage) [![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6925/badge)](https://bestpractices.coreinfrastructure.org/projects/6925) +[![NFDI4C Registry](https://img.shields.io/badge/included%20in%20NFDI4C%20registry-64BEA0)](https://nfdi4culture.de/resources/registry/details/teigarage) ## Table of Contents From 006bc08428ea7a13c528b6e7a12dd868864c070a Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Fri, 23 Jun 2023 12:46:14 +0200 Subject: [PATCH 19/32] Update .howfairis.yml --- .howfairis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.howfairis.yml b/.howfairis.yml index 0641545..8e56871 100644 --- a/.howfairis.yml +++ b/.howfairis.yml @@ -1 +1 @@ -skip_registry_checks_reason : "will be registered in NFDI4Culture Registry for Tools & Services" +skip_registry_checks_reason : "registered in NFDI4Culture Registry for Tools & Services at https://nfdi4culture.de/de/ressourcen/registry/details/teigarage" From fd8240be23ff5081c7c1b9c4f4e94b0c748eabf2 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Fri, 30 Jun 2023 17:34:10 +0200 Subject: [PATCH 20/32] dependency update --- pom.xml | 24 ++++++++++++++---------- 1 file changed, 14 insertions(+), 10 deletions(-) diff --git a/pom.xml b/pom.xml index e7a2d6d..b95ab09 100644 --- a/pom.xml +++ b/pom.xml @@ -159,7 +159,7 @@ ${project.artifactId}-${project.version} --> - + org.apache.maven.plugins maven-pmd-plugin 3.13.0 @@ -168,15 +168,19 @@ true false - + + + org.owasp + dependency-check-maven + 8.3.1 + - compile - - check - + + check + - - + + @@ -190,12 +194,12 @@ io.swagger.core.v3 swagger-jaxrs2 - 2.2.0 + 2.2.10 io.swagger.core.v3 swagger-jaxrs2-servlet-initializer-v2 - 2.2.0 + 2.2.10 javax.ws.rs From ad0432b2b34aff53958a30b3fd6edee9da0265d2 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Fri, 30 Jun 2023 18:07:54 +0200 Subject: [PATCH 21/32] dependency updates --- pom.xml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/pom.xml b/pom.xml index b95ab09..169d55d 100644 --- a/pom.xml +++ b/pom.xml @@ -142,7 +142,7 @@ org.apache.maven.plugins maven-compiler-plugin - 3.10.1 + 3.11.0 11 11 @@ -162,7 +162,7 @@ org.apache.maven.plugins maven-pmd-plugin - 3.13.0 + 3.21.0 false true @@ -194,17 +194,17 @@ io.swagger.core.v3 swagger-jaxrs2 - 2.2.10 + 2.2.14 io.swagger.core.v3 swagger-jaxrs2-servlet-initializer-v2 - 2.2.10 + 2.2.14 javax.ws.rs javax.ws.rs-api - 2.1 + 2.1.1 pl.psnc.dl.ege From 3986ee00c6b053b85d74a2c4218b6fe6d5ccfaa3 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 10 Jul 2023 10:28:47 +0000 Subject: [PATCH 22/32] Bump swagger-jaxrs2 from 2.2.14 to 2.2.15 Bumps swagger-jaxrs2 from 2.2.14 to 2.2.15. --- updated-dependencies: - dependency-name: io.swagger.core.v3:swagger-jaxrs2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 169d55d..17f4d49 100644 --- a/pom.xml +++ b/pom.xml @@ -194,7 +194,7 @@ io.swagger.core.v3 swagger-jaxrs2 - 2.2.14 + 2.2.15 io.swagger.core.v3 From ec8a8afe6f604f610bdfa4f198359ae06b4104ee Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 10 Jul 2023 10:28:52 +0000 Subject: [PATCH 23/32] Bump swagger-jaxrs2-servlet-initializer-v2 from 2.2.14 to 2.2.15 Bumps swagger-jaxrs2-servlet-initializer-v2 from 2.2.14 to 2.2.15. --- updated-dependencies: - dependency-name: io.swagger.core.v3:swagger-jaxrs2-servlet-initializer-v2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 169d55d..98e239b 100644 --- a/pom.xml +++ b/pom.xml @@ -199,7 +199,7 @@ io.swagger.core.v3 swagger-jaxrs2-servlet-initializer-v2 - 2.2.14 + 2.2.15 javax.ws.rs From a7c1d7f6af36f0867f243ae773eadfd837c7e70d Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Mon, 24 Jul 2023 10:58:12 +0200 Subject: [PATCH 24/32] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 0fa125a..1ba0d70 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![Docker](https://img.shields.io/docker/pulls/teic/teigarage)](https://hub.docker.com/r/teic/teigarage) [![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6925/badge)](https://bestpractices.coreinfrastructure.org/projects/6925) -[![NFDI4C Registry](https://img.shields.io/badge/included%20in%20NFDI4C%20registry-64BEA0)](https://nfdi4culture.de/resources/registry/details/teigarage) +[![NFDI4C Registry](https://img.shields.io/badge/included%20in%20NFDI4Culture%20registry-64BEA0)](https://nfdi4culture.de/id/E4102) ## Table of Contents From afd5ffd49c8d85c4d60819c9687d082e21b4a7b2 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Wed, 18 Oct 2023 10:36:02 +0200 Subject: [PATCH 25/32] Updated NFDI4Culture Registry badge --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1ba0d70..4d3630c 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ [![Docker](https://img.shields.io/docker/pulls/teic/teigarage)](https://hub.docker.com/r/teic/teigarage) [![fair-software.eu](https://img.shields.io/badge/fair--software.eu-%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F%20%20%E2%97%8F-green)](https://fair-software.eu) [![OpenSSF Best Practices](https://bestpractices.coreinfrastructure.org/projects/6925/badge)](https://bestpractices.coreinfrastructure.org/projects/6925) -[![NFDI4C Registry](https://img.shields.io/badge/included%20in%20NFDI4Culture%20registry-64BEA0)](https://nfdi4culture.de/id/E4102) +[![NFDI4C Registry](https://img.shields.io/badge/NFDI4Culture%20Registry-64BEA0)](https://nfdi4culture.de/id/E4102) ## Table of Contents From 0ac2e03a77de2de97b348597a62ed9f2758d8276 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 17 Nov 2023 16:58:50 +0000 Subject: [PATCH 26/32] Bump org.owasp:dependency-check-maven from 8.3.1 to 8.4.3 Bumps [org.owasp:dependency-check-maven](https://github.com/jeremylong/DependencyCheck) from 8.3.1 to 8.4.3. - [Release notes](https://github.com/jeremylong/DependencyCheck/releases) - [Changelog](https://github.com/jeremylong/DependencyCheck/blob/main/CHANGELOG.md) - [Commits](https://github.com/jeremylong/DependencyCheck/compare/v8.3.1...v8.4.3) --- updated-dependencies: - dependency-name: org.owasp:dependency-check-maven dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index e1b31f4..1b8e932 100644 --- a/pom.xml +++ b/pom.xml @@ -172,7 +172,7 @@ org.owasp dependency-check-maven - 8.3.1 + 8.4.3 From b2f54419c508823a0b20d4244f453023b3e2d77b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 10:15:05 +0000 Subject: [PATCH 27/32] Bump io.swagger.core.v3:swagger-jaxrs2 from 2.2.15 to 2.2.19 Bumps io.swagger.core.v3:swagger-jaxrs2 from 2.2.15 to 2.2.19. --- updated-dependencies: - dependency-name: io.swagger.core.v3:swagger-jaxrs2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 1b8e932..798d13f 100644 --- a/pom.xml +++ b/pom.xml @@ -194,7 +194,7 @@ io.swagger.core.v3 swagger-jaxrs2 - 2.2.15 + 2.2.19 io.swagger.core.v3 From 0f1ceb26a1f3dc079ba7f9d2246e405c7d12f40b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 10:15:07 +0000 Subject: [PATCH 28/32] Bump io.swagger.core.v3:swagger-jaxrs2-servlet-initializer-v2 Bumps io.swagger.core.v3:swagger-jaxrs2-servlet-initializer-v2 from 2.2.15 to 2.2.19. --- updated-dependencies: - dependency-name: io.swagger.core.v3:swagger-jaxrs2-servlet-initializer-v2 dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 1b8e932..64b5722 100644 --- a/pom.xml +++ b/pom.xml @@ -199,7 +199,7 @@ io.swagger.core.v3 swagger-jaxrs2-servlet-initializer-v2 - 2.2.15 + 2.2.19 javax.ws.rs From d6c32b0e6829dc7142ee8dfdf39bde6f23e98471 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 20 Nov 2023 10:15:11 +0000 Subject: [PATCH 29/32] Bump org.apache.maven.plugins:maven-pmd-plugin from 3.21.0 to 3.21.2 Bumps [org.apache.maven.plugins:maven-pmd-plugin](https://github.com/apache/maven-pmd-plugin) from 3.21.0 to 3.21.2. - [Release notes](https://github.com/apache/maven-pmd-plugin/releases) - [Commits](https://github.com/apache/maven-pmd-plugin/compare/maven-pmd-plugin-3.21.0...maven-pmd-plugin-3.21.2) --- updated-dependencies: - dependency-name: org.apache.maven.plugins:maven-pmd-plugin dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 1b8e932..1c13de0 100644 --- a/pom.xml +++ b/pom.xml @@ -162,7 +162,7 @@ org.apache.maven.plugins maven-pmd-plugin - 3.21.0 + 3.21.2 false true From 4a8df679706c1a296ed3fe17cbabbca637469b7f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 27 Nov 2023 10:11:12 +0000 Subject: [PATCH 30/32] Bump org.owasp:dependency-check-maven from 8.4.3 to 9.0.1 Bumps [org.owasp:dependency-check-maven](https://github.com/jeremylong/DependencyCheck) from 8.4.3 to 9.0.1. - [Release notes](https://github.com/jeremylong/DependencyCheck/releases) - [Changelog](https://github.com/jeremylong/DependencyCheck/blob/main/CHANGELOG.md) - [Commits](https://github.com/jeremylong/DependencyCheck/compare/v8.4.3...v9.0.1) --- updated-dependencies: - dependency-name: org.owasp:dependency-check-maven dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index ae07831..e467fef 100644 --- a/pom.xml +++ b/pom.xml @@ -172,7 +172,7 @@ org.owasp dependency-check-maven - 8.4.3 + 9.0.1 From aa4c00c6405aecd3c4d3f27de1f422884988ccb3 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Mon, 27 Nov 2023 16:12:49 +0100 Subject: [PATCH 31/32] new version of tei-converter --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 169d55d..db8ecde 100644 --- a/pom.xml +++ b/pom.xml @@ -227,7 +227,7 @@ pl.psnc.dl.ege.tei tei-converter - 0.6.4 + 0.6.5 compile From 7857da5beb2b09cbeef930aaf329ce66da7b6157 Mon Sep 17 00:00:00 2001 From: Anne Ferger Date: Tue, 28 Nov 2023 09:47:13 +0100 Subject: [PATCH 32/32] add new tei guidelines and stylesheets to docker image --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index f95b9af..b3fd3aa 100644 --- a/pom.xml +++ b/pom.xml @@ -3,7 +3,7 @@ 4.0.0 pl.psnc.dl.ege.webapp teigarage - 1.1.1 + 1.2.1 war TEI Garage