From 2e7ecb5efc2288beccd5b3f22a2075a5a61cb7f5 Mon Sep 17 00:00:00 2001
From: "(Jip) Willem Wijnia" <w.b.wijnia@gmail.com>
Date: Mon, 29 Jul 2024 14:37:30 +0200
Subject: [PATCH] First working setup of automated changelogs for the
 deployment branches (#6373)

Now we can improve the templates and apply various other refinements.
---
 .github/workflows/changelog.yaml |  7 +------
 .github/workflows/docs-build.yml | 14 +++++++-------
 docs/changelogs/fafbeta.md       |  5 ++++-
 docs/changelogs/fafdevelop.md    |  4 +++-
 docs/development/start-here.md   | 12 ------------
 5 files changed, 15 insertions(+), 27 deletions(-)
 delete mode 100644 docs/development/start-here.md

diff --git a/.github/workflows/changelog.yaml b/.github/workflows/changelog.yaml
index 4a566e8112..10c9269506 100644
--- a/.github/workflows/changelog.yaml
+++ b/.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
diff --git a/.github/workflows/docs-build.yml b/.github/workflows/docs-build.yml
index 8253964827..135566fb74 100644
--- a/.github/workflows/docs-build.yml
+++ b/.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
 
diff --git a/docs/changelogs/fafbeta.md b/docs/changelogs/fafbeta.md
index 84ff99f771..37e598324a 100644
--- a/docs/changelogs/fafbeta.md
+++ b/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.
+-->
+
diff --git a/docs/changelogs/fafdevelop.md b/docs/changelogs/fafdevelop.md
index bfc8148299..783369dfcf 100644
--- a/docs/changelogs/fafdevelop.md
+++ b/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.
+-->
diff --git a/docs/development/start-here.md b/docs/development/start-here.md
deleted file mode 100644
index 5fbb140a5c..0000000000
--- a/docs/development/start-here.md
+++ /dev/null
@@ -1,12 +0,0 @@
----
-layout: page
-nav_order: 1
-title: Start here
-parent: Development
-has_children: true
-permalink: development/start-here
----
-
-# Start of a development journey
-
-{: .no_toc}
\ No newline at end of file