diff --git a/.github/workflows/deploy_docusaurus.yml b/.github/workflows/deploy_docusaurus.yml new file mode 100644 index 0000000..58b8661 --- /dev/null +++ b/.github/workflows/deploy_docusaurus.yml @@ -0,0 +1,66 @@ +# +# This workflow is based on the example workflow from the docusaurus documentation: +# https://docusaurus.io/docs/deployment#triggering-deployment-with-github-actions +# The Docusaurus documentation is licensed under the CC-BY-4.0 license. See +# https://github.com/facebook/docusaurus/blob/6c7f2fde20b2448a1b966dd5f674205c0a08eeba/LICENSE-docs +# for more information. +# + +name: "Deploy: Docusaurus Documentation" + +on: + push: + branches: + - main + +jobs: + build-docusaurus: + name: Build Docusaurus + runs-on: ubuntu-latest + + defaults: + run: + working-directory: ./docs + + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 18 + cache: yarn + cache-dependency-path: './docs/package-lock.json' + + - name: Install dependencies + run: yarn install --frozen-lockfile + - name: Build website + run: yarn build + + - name: Upload Build Artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ./docs/build + + deploy-docusaurus: + name: Deploy to GitHub Pages + needs: build-docusaurus + + permissions: + pages: write + id-token: write + + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + + runs-on: ubuntu-latest + + defaults: + run: + working-directory: ./docs + + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/watermarker_docs.yml b/.github/workflows/deploy_watermarker-source-code-docs.yml similarity index 95% rename from .github/workflows/watermarker_docs.yml rename to .github/workflows/deploy_watermarker-source-code-docs.yml index fad2e39..a450b12 100644 --- a/.github/workflows/watermarker_docs.yml +++ b/.github/workflows/deploy_watermarker-source-code-docs.yml @@ -5,12 +5,10 @@ # that can be found in the LICENSE file. # -name: "Watermarker: Generate API docs" +name: "Deploy: Watermarker API docs" on: - push: - branches: - - main + workflow_dispatch: permissions: contents: write diff --git a/.github/workflows/test_cli.yml b/.github/workflows/test_cli.yml index 18951f8..b94a911 100644 --- a/.github/workflows/test_cli.yml +++ b/.github/workflows/test_cli.yml @@ -5,7 +5,7 @@ # that can be found in the LICENSE file. # -name: "CLI: Test" +name: "Test: CLI" on: push: diff --git a/.github/workflows/test_docusaurus.yml b/.github/workflows/test_docusaurus.yml new file mode 100644 index 0000000..8855468 --- /dev/null +++ b/.github/workflows/test_docusaurus.yml @@ -0,0 +1,39 @@ +# +# This workflow is based on the example workflow from the docusaurus documentation: +# https://docusaurus.io/docs/deployment#triggering-deployment-with-github-actions +# The Docusaurus documentation is licensed under the CC-BY-4.0 license. See +# https://github.com/facebook/docusaurus/blob/6c7f2fde20b2448a1b966dd5f674205c0a08eeba/LICENSE-docs +# for more information. +# + +name: "Test: Docusaurus Documentation Deployment" + +on: + pull_request: + branches: + - main + +jobs: + test-deploy-docusaurus: + name: Test deployment + runs-on: ubuntu-latest + + defaults: + run: + working-directory: ./docs + + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-node@v4 + with: + node-version: 18 + cache: yarn + cache-dependency-path: './docs/package-lock.json' + + - name: Install dependencies + run: yarn install --frozen-lockfile + + - name: Test build website + run: yarn build diff --git a/.github/workflows/test_watermarker.yml b/.github/workflows/test_watermarker.yml index 51e6922..ebc1c95 100644 --- a/.github/workflows/test_watermarker.yml +++ b/.github/workflows/test_watermarker.yml @@ -5,7 +5,7 @@ # that can be found in the LICENSE file. # -name: "Watermarker: Test" +name: "Test: Watermarker" on: push: diff --git a/.github/workflows/test_webinterface.yml b/.github/workflows/test_webinterface.yml index 14aaca9..36581bb 100644 --- a/.github/workflows/test_webinterface.yml +++ b/.github/workflows/test_webinterface.yml @@ -5,7 +5,7 @@ # that can be found in the LICENSE file. # -name: "Webinterface: Test" +name: "Test: Webinterface" on: push: diff --git a/.gitignore b/.gitignore index 423dc61..bbeec1c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,11 @@ -# Created by https://www.toptal.com/developers/gitignore/api/intellij+iml,gradle,maven,kotlin,java,git +# +# Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V. +# +# This work is licensed under the Fraunhofer License (on the basis of the MIT license) +# that can be found in the LICENSE file. +# +# The initial version of this file was created by .gitignore from Toptal. +# See https://www.toptal.com/developers/gitignore/api/intellij+iml,gradle,maven,kotlin,java,git # Edit at https://www.toptal.com/developers/gitignore?templates=intellij+iml,gradle,maven,kotlin,java,git ### Git ### diff --git a/.idea/codeStyles/Project.xml b/.idea/codeStyles/Project.xml index 8ebe633..84b0e7a 100644 --- a/.idea/codeStyles/Project.xml +++ b/.idea/codeStyles/Project.xml @@ -1,5 +1,6 @@ +