Merge branch 'master' of github.com:Ocelot-Social-Community/Ocelot-Social into 6678-add-chat-item-to-avatar-navigation-menu

.github/file-filters.yml

@@ -12,5 +12,20 @@ webapp: &webapp
   - 'webapp/**/*'
   - 'package.json'
 
-markdown-files: &markdown-files
+docs-check: &docs-check
+  - '.github/workflows/check-documentation.yml'
+
+markdown: &markdown
+  - *docs-check
   - '**/*.md'
+  - '.github/workflows/mlc_config.json'
+
+vuepress: &vuepress
+  - *docs-check
+  - '.github/workflows/deploy-documentation.yml'
+  - '.vuepress/**/*'
+  - 'package.json'
+
+documentation: &documentation
+  - *vuepress
+  - *markdown

.github/workflows/check-documentation.yml

@@ -7,7 +7,8 @@ jobs:
     name: Detect File Changes - Markdown files
     runs-on: ubuntu-latest
     outputs:
-      markdown-files: ${{ steps.changes.outputs.markdown-files }}
+      markdown: ${{ steps.changes.outputs.markdown }}
+      documentation: ${{ steps.changes.outputs.documentation }}
     steps:
       - name: Checkout code
         uses: actions/checkout@master
@@ -22,21 +23,43 @@ jobs:
 
   check-markdown-links:
     name: Check Markdown links
-    if: needs.files-changed.outputs.markdown-files == 'true'
     needs: files-changed
     runs-on: ubuntu-latest
+    if: needs.files-changed.outputs.markdown == 'true'
     steps:
-    - name: Checkout code
+      - name: Checkout code
-      uses: actions/checkout@master
+        uses: actions/checkout@master
-    - name: Remove old documentation files
+      
-      run: rm -rf ./deployment/src/old/ ./CHANGELOG.md # workaround until https://github.com/gaurav-nelson/github-action-markdown-link-check/pull/183 has been done
+      - name: Remove old documentation files
-    - name: Check Markdown Links
+        run: rm -rf ./deployment/src/old/ ./CHANGELOG.md # workaround until https://github.com/gaurav-nelson/github-action-markdown-link-check/pull/183 has been done
-      uses: gaurav-nelson/github-action-markdown-link-check@master
+
-      with:
+      - name: Check Markdown Links
-        use-quiet-mode: 'yes'
+        uses: gaurav-nelson/github-action-markdown-link-check@master
-        use-verbose-mode: 'no'
+        with:
-        # at any .md file change take the chance to check the links in all .md files
+          use-quiet-mode: 'yes'
-        check-modified-files-only: 'no'
+          use-verbose-mode: 'no'
-        config-file: '.github/workflows/mlc_config.json'
+          # at any .md file change take the chance to check the links in all .md files
-        base-branch: 'master'
+          check-modified-files-only: 'no'
-        folder-path: '.'
+          config-file: '.github/workflows/mlc_config.json'
+          base-branch: 'master'
+          folder-path: '.'
+
+  test-vuepress-build:
+    name: Test Vuepress build
+    needs: files-changed
+    runs-on: ubuntu-latest
+    if: needs.files-changed.outputs.documentation == 'true'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@master
+
+      - name: Setup Node 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: npm-install
+        run: npm install
+
+      - name: npm-docs:build
+        run: npm run docs:build

.github/workflows/deploy-documentation.yml

@@ -0,0 +1,48 @@
+name: ocelot.social deploy documentation
+
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  files-changed:
+    name: Detect File Changes - Markdown and Vuepress files
+    runs-on: ubuntu-latest
+    outputs:
+      documentation: ${{ steps.changes.outputs.documentation }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@master
+
+      - name: Check for file changes
+        uses: dorny/paths-filter@master
+        id: changes
+        with:
+          token: ${{ github.token }}
+          filters: .github/file-filters.yml
+          list-files: shell
+
+  build-and-deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@master
+
+      - name: Setup Node 20
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+
+      - name: Build Vuepress Pages
+        run: npm install && npm run build
+
+      - name: Deploy Vuepress to Github Pages
+        uses: crazy-max/ghaction-github-pages@v4
+        with:
+          target_branch: gh-pages
+          build_dir: .vuepress/dist
+          author: Wolfgang Huß <vorstand@busfaktor.org>
+          fqdn: docs.ocelot.social
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/publish.yml

@@ -260,38 +260,10 @@ jobs:
           version: ${{ env.BUILD_VERSION }}
           git_commit_sha: ${{ github.sha }}
           git_tag_prefix: "b"
-
       - name: Generate changelog
-        id: changelog
+        run: |
-        uses: mikepenz/release-changelog-builder-action@v4
+          yarn install
-        with:
+          yarn auto-changelog --latest-version ${{ env.VERSION }} --unreleased-only
-          configurationJson: |
-            {
-              "pr_template": "- ##{{NUMBER}} #{{TITLE}} #{{ASSIGNEES}}",
-              "categories": [
-                {
-                    "title": "### 🚀 Features",
-                    "labels": ["feat"]
-                },
-                {
-                    "title": "### 🐛 Fixes",
-                    "labels": ["fix"]
-                },
-                {
-                    "title": "### 💬 Refactoring, Documentation & Other",
-                    "labels": ["chore","ci","docs","refactor"]
-                },
-                {
-                    "title": "### 📦 Build & Dependencies",
-                    "labels": ["build","bump"]
-                }
-              ],
-              "max_pull_requests": 1000,
-              "max_back_track_time_days": 1000
-            }
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-
       - name: package-version-to-git-release
         continue-on-error: true # Will fail if tag exists
         id: create_release
@@ -301,7 +273,7 @@ jobs:
         with:
           tag_name: ${{ env.VERSION }}
           release_name: ${{ env.VERSION }}
-          body: ${{steps.changelog.outputs.changelog}}
+          body_path: ./CHANGELOG.md
           draft: false
           prerelease: false