Merge branch 'develop' into feature/SACU-Rebalance

.github/workflows/deploy-faf.yaml

@@ -41,7 +41,15 @@ jobs:
         uses: actions/checkout@v4
         with:
             repository: FAForever/fa
-            ref: develop
+            ref: master
+
+      # Disable debugging statements
+      - name: Update references
+        run: |
+          sed -i 's/EnabledSpewing = true,/EnabledSpewing = false,/' "/lua/shared/components/DebugComponent.lua"
+          sed -i 's/EnabledLogging = true,/EnabledLogging = false,/' "/lua/shared/components/DebugComponent.lua"
+          sed -i 's/EnabledWarnings = true,/EnabledWarnings = false,/' "/lua/shared/components/DebugComponent.lua"
+          sed -i 's/EnabledDrawing = true,/EnabledDrawing = false,/' "/lua/shared/components/DebugComponent.lua"
 
       # Update the deploy/faf branch, we force push here because 
       # we're not interested in fixing conflicts

.github/workflows/deploy-fafbeta.yaml

@@ -44,6 +44,13 @@ jobs:
             repository: FAForever/fa
             ref: develop
 
+      # Disable debugging statements
+      # 
+      # You can overwrite these adjustments by setting up a `Debug` folder
+      - name: Update references
+        run: |
+          sed -i 's/EnabledDrawing = true,/EnabledDrawing = false,/' "/lua/shared/components/DebugComponent.lua"
+
       # Update the deploy/fafbeta branch, we force push here because 
       # we're not interested in fixing conflicts
       - name: Update deploy/fafbeta

.github/workflows/deploy-fafdevelop.yaml

@@ -44,6 +44,13 @@ jobs:
             repository: FAForever/fa
             ref: develop
 
+      # Disable debugging statements
+      # 
+      # You can overwrite these adjustments by setting up a `Debug` folder
+      - name: Update references
+        run: |
+          sed -i 's/EnabledDrawing = true,/EnabledDrawing = false,/' "/lua/shared/components/DebugComponent.lua"
+
       # Update the deploy/fafdevelop branch, we force push here because 
       # we're not interested in fixing conflicts
       - name: Update deploy/fafdevelop

.github/workflows/docs-build.yml

@@ -0,0 +1,121 @@
+# Copyright (c) FAForever
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+name: Documentation - Build and deploy
+
+on:
+  push:
+    branches: ["develop", "deploy/fafdevelop", "deploy/fafbeta", "deploy/faf"]
+    paths: ["docs/**", "changelog/snippets/*.md"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  changelog-develop:
+    name: Create changelog of FAF Develop
+    uses: ./.github/workflows/docs-changelog.yaml
+    with:
+      reference: deploy/fafdevelop
+
+  changelog-beta:
+    name: Create changelog of FAF Beta
+    uses: ./.github/workflows/docs-changelog.yaml
+    with:
+      reference: deploy/fafbeta
+
+  build:
+    name: Build the documentation
+    needs: [changelog-develop, changelog-beta]
+    runs-on: ubuntu-latest
+    defaults:
+      run:
+        working-directory: docs
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            docs
+
+      # Retrieve the generated changelogs
+      - name: Download artifact changelog of FAF Develop
+        uses: actions/download-artifact@v4
+        with:
+          name: changelog-fafdevelop
+          path: docs/generated
+
+      - name: Download artifact changelog of FAF Beta
+        uses: actions/download-artifact@v4
+        with:
+          name: changelog-fafbeta
+          path: docs/generated
+
+      # Append the generated changelogs to the Jekyll-compatible templates
+      - name: Append the generated changelogs
+        run: |
+          cat generated/fafdevelop.md >> patches/fafdevelop.md
+          cat generated/fafbeta.md >> patches/fafbeta.md
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "3.3"
+          bundler-cache: true
+          cache-version: 0
+          working-directory: "${{ github.workspace }}/docs"
+
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v5
+
+      - name: Build with Jekyll
+        # Outputs to the './_site' directory by default
+        run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
+        env:
+          JEKYLL_ENV: production
+
+      - name: Upload artifact
+        # Automatically uploads an artifact from the './_site' directory by default
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: "docs/_site/"
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/docs-changelog.yaml

@@ -0,0 +1,135 @@
+# Copyright (c) 2024 Willem 'Jip' Wijnia
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+name: Documentation - Generate changelog
+
+on:
+  workflow_dispatch:
+    inputs:
+      reference:
+        required: true
+        type: choice
+        description: The reference (branch or tag) to use to compile the changelog snippets from
+        options:
+          - develop
+          - deploy/fafbeta
+          - deploy/fafdevelop
+
+  workflow_call:
+    inputs:
+      reference:
+        required: true
+        type: string
+        description: The reference (branch or tag) to use to compile the changelog snippets from
+
+  pull_request:
+    paths:
+      - "changelog/snippets/*.md"
+  push:
+    branches:
+      - deploy/fafdevelop
+
+jobs:
+
+  # By verifying the snippets we ensure that they're compatible with the bundling  
+  # process. In the future we can also add spell checking and/or checks for foul words.
+
+  verify:
+    name: Verify snippets
+    runs-on: ubuntu-latest
+    steps:
+
+      # We check out the scripts separate because the branch that we use to 
+      # generate the changelog may not contain the scripts that we want to work with.
+      - name: Checkout scripts
+        uses: actions/checkout@v4
+        with:
+          path: scripts
+          sparse-checkout: |
+            .github/workflows/scripts
+
+      - name: Checkout snippets
+        uses: actions/checkout@v4
+        with:
+          path: fa
+          ref: ${{ inputs.reference }}
+          sparse-checkout: |
+            changelog/snippets
+
+      - name: Update environment path
+        run: |
+          ls
+          echo "${{ github.workspace }}/scripts/.github/workflows/scripts" >> $GITHUB_PATH
+
+      - name: Verify the changelog snippets
+        working-directory: fa/changelog/snippets # script assumes it is in this directory
+        run: |
+          changelog-verify.sh
+
+  # During the bundling process we combine the templates, the sections and the snippets
+  # into a single changelog. 
+
+  bundle:
+    name: Bundle snippets
+    runs-on: ubuntu-latest
+    needs: [verify]
+    steps:
+
+      # We check out the scripts separate because the branch that we use to 
+      # generate the changelog may not contain the scripts that we want to work with.
+      - name: Checkout scripts
+        uses: actions/checkout@v4
+        with:
+          path: scripts
+          sparse-checkout: |
+            .github/workflows/scripts
+
+      - name: Checkout snippets
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ inputs.reference }}
+          path: fa
+          sparse-checkout: |
+            changelog/snippets
+
+      - name: Update environment path
+        run: |
+          echo "${{ github.workspace }}/scripts/.github/workflows/scripts" >> $GITHUB_PATH
+
+      # We need to do this to remove `deploy/` from the reference. Specifically the `/` is problematic
+      - name: Update reference
+        run: |
+          REFERENCE="${{ inputs.reference }}"
+          NAME="${REFERENCE#deploy/}"
+          echo "NAME=$NAME" >> $GITHUB_ENV
+
+      - name: Create the changelog
+        working-directory: fa/changelog/snippets # script assumes it is in this directory
+        run: |
+          echo $NAME
+          echo ${{ env.NAME }}
+          changelog-combine.sh ${{ env.NAME }}
+
+      - name: Add the changelog as an artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: changelog-${{ env.NAME }}
+          path: |
+            fa/changelog/snippets/${{ env.NAME }}.md

.github/workflows/docs-spelling-check.yaml

@@ -0,0 +1,48 @@
+# Copyright (c) 2024 Willem 'Jip' Wijnia
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+name: Documentation - Verify spelling
+
+on:
+  push:
+    branches: ["develop"]
+    paths: ["docs/**"]
+
+  pull_request: 
+    paths: ["docs/**"]
+
+jobs:
+  verify:
+    name: Verify spelling
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            docs
+
+      - name: Check spelling
+        uses: check-spelling/check-spelling@main
+        with:
+          checkout: false
+          experimental_path: docs
+          only_check_changed_files: true
+