First working setup of automated changelogs for the deployment branch…

…es (#6373)

Now we can improve the templates and apply various other refinements.

.github/workflows/changelog.yaml

@@ -26,7 +26,6 @@ on:
       reference:
         required: true
         type: choice
-        default: develop
         description: The reference (branch or tag) to use to compile the changelog snippets from
         options:
           - develop
@@ -38,7 +37,6 @@ on:
       reference:
         required: true
         type: string
-        default: develop
         description: The reference (branch or tag) to use to compile the changelog snippets from
 
   pull_request:
@@ -57,7 +55,6 @@ jobs:
         uses: actions/checkout@v4
         with:
           path: scripts
-          ref: develop
           sparse-checkout: |
             .github/workflows/scripts
 
@@ -67,7 +64,6 @@ jobs:
           path: fa
           ref: ${{ inputs.reference }}
           sparse-checkout: |
-            .github/workflows/scripts
             changelog/snippets
 
       - name: Update environment path
@@ -89,16 +85,15 @@ jobs:
         uses: actions/checkout@v4
         with:
           path: scripts
-          ref: develop
           sparse-checkout: |
             .github/workflows/scripts
 
       - name: Checkout code
         uses: actions/checkout@v4
         with:
+          ref: ${{ inputs.reference }}
           path: fa
           sparse-checkout: |
-            .github/workflows/scripts
             changelog/snippets
 
       - name: Update environment path

.github/workflows/docs-build.yml

@@ -2,14 +2,12 @@
 # They are provided by a third-party and are governed by
 # separate terms of service, privacy policy, and support
 # documentation.
-
-# Sample workflow for building and deploying a Jekyll site to GitHub Pages
 name: Documentation - Build and deploy
 
 on:
   push:
-    branches: ['develop']
-    paths: ['docs/**']
+    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:
@@ -26,18 +24,20 @@ concurrency:
   cancel-in-progress: true
 
 jobs:
-  # Build job
   changelog-develop:
+    name: Create changelog of FAF Develop
     uses: ./.github/workflows/changelog.yaml
     with:
       reference: deploy/fafdevelop
 
   changelog-beta:
+    name: Create changelog of FAF Beta
     uses: ./.github/workflows/changelog.yaml
     with:
       reference: deploy/fafbeta
 
   build:
+    name: Build the documentation
     needs: [changelog-develop, changelog-beta]
     runs-on: ubuntu-latest
     defaults:
@@ -47,10 +47,10 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
         with:
-          ref: develop
           sparse-checkout: | 
             docs
 
+      # Retrieve the generated changelogs
       - name: Download artifact changelog of FAF Develop
         uses: actions/download-artifact@v4
         with:
@@ -63,9 +63,9 @@ jobs:
           name: changelog-fafbeta
           path: docs/generated
 
+      # Merge the generated changelogs into the templates
       - name: Append the generated changelogs
         run: |
-          ls -Rla generated
           cat generated/fafdevelop.md >> changelogs/fafdevelop.md
           cat generated/fafbeta.md >> changelogs/fafbeta.md
 

docs/changelogs/fafbeta.md

@@ -6,4 +6,7 @@ nav_order: 2
 parent: Changelog
 ---
 
-Open changes on FAF Beta Balance
+<!--
+    This is a template, content is appended automatically based on changelog snippets.
+-->
+

docs/changelogs/fafdevelop.md

@@ -6,4 +6,6 @@ nav_order: 1
 parent: Changelog
 ---
 
-Open changes on FAF Develop
+<!--
+    This is a template, content is appended automatically based on changelog snippets.
+-->