Rename and fix changelog generation workflow

Author: BlackYps

.github/workflows/docs-build.yml

@@ -52,13 +52,13 @@ concurrency:
 jobs:
   changelog-develop:
     name: Create changelog of FAF Develop
-    uses: ./.github/workflows/docs-changelog.yaml
+    uses: ./.github/workflows/docs-generate-changelog.yaml
     with:
       reference: deploy/fafdevelop
 
   changelog-beta:
     name: Create changelog of FAF Beta
-    uses: ./.github/workflows/docs-changelog.yaml
+    uses: ./.github/workflows/docs-generate-changelog.yaml
     with:
       reference: deploy/fafbeta
 

.github/workflows/docs-changelog.yaml …b/workflows/docs-generate-changelog.yaml.github/workflows/docs-changelog.yaml renamed to .github/workflows/docs-generate-changelog.yaml .github/workflows/docs-changelog.yaml renamed to .github/workflows/docs-generate-changelog.yaml

@@ -31,11 +31,12 @@ on:
       reference:
         required: true
         type: string
-        description: The reference (branch or tag) to use to compile the changelog snippets from
+        description: The reference (branch or tag) to use
 
   pull_request:
     paths:
       - "changelog/snippets/*.md"
+
   push:
     branches:
       - deploy/fafdevelop
@@ -77,17 +78,17 @@ jobs:
 
       - name: Create the changelog file
         working-directory: fa/changelog/snippets # script assumes it is in this directory
-        # We need to remove `deploy/` from the branch name.
+        # We need to remove the `/` any anything in front of it from the branch name.
         # Specifically the `/` is problematic in a file name.
         run: |
           REFERENCE="${{ inputs.reference || github.head_ref || github.ref_name}}"
-          NAME="changelog-${REFERENCE#deploy/}"
+          NAME="changelog-${REFERENCE#*/}"
           echo "NAME=$NAME" >> $GITHUB_ENV
           changelog-combine.sh ${{ env.NAME }}
 
       - name: Add the changelog as an artifact
         uses: actions/upload-artifact@v4
         with:
-          name: changelog-${{ env.NAME }}
+          name: ${{ env.NAME }}
           path: |
             fa/changelog/snippets/${{ env.NAME }}.md

docs/development-changelog.md

@@ -16,7 +16,7 @@ All changelogs can be found in the [changelog folder](https://github.com/FAForev
 
 ## Changelog snippets
 
-We use snippets to reduce the burden on maintainers to write an accurate changelog and at the same time enable contributors to describe the changes of a pull request. A contributor is required to create a snippet before a pull request is merged. Remember that the target audience of the changelog are the players, so try to make the changelog easily understandable. All snippets reside in the [snippets folder](https://github.com/FAForever/fa/blob/develop/changelog/snippets/). We use a [workflow](https://github.com/FAForever/fa/blob/develop/.github/workflows/docs-changelog.yaml) to compile the snippets into a typical changelog file. This changelog file can then be tweaked, spell checked and be used as (intermediate) release notes.
+We use snippets to reduce the burden on maintainers to write an accurate changelog and at the same time enable contributors to describe the changes of a pull request. A contributor is required to create a snippet before a pull request is merged. Remember that the target audience of the changelog are the players, so try to make the changelog easily understandable. All snippets reside in the [snippets folder](https://github.com/FAForever/fa/blob/develop/changelog/snippets/). We use a [workflow](https://github.com/FAForever/fa/blob/develop/.github/workflows/docs-generate-changelog.yaml) to compile the snippets into a typical changelog file. This changelog file can then be tweaked, spell checked and be used as (intermediate) release notes.
 
 ### Format of a snippet