split docs into two workflows

Author: mattkjames7

.github/workflows/build-docs.yml

@@ -3,26 +3,24 @@ name: Build Docs
 on:
   workflow_dispatch:
     inputs:
-      publish:
-        description: "Publish docs"
-        required: false
-        type: boolean
-        default: false
       branch:
-        description: "Branch to build"
+        description: "Branch to build from"
         required: false
         type: string
+      version:
+        description: "Version to build from"
+        required: true
+        type: string
   workflow_call:
     inputs:
-      publish:
-        description: "Publish docs"
-        required: false
-        type: boolean
-        default: false
       branch:
         description: "Branch to build from"
         required: false
         type: string
+      version:
+        description: "Version to build from"
+        required: true
+        type: string
 
 jobs:
   build-docs:
@@ -33,11 +31,26 @@ jobs:
         with:
           ref: ${{ inputs.branch }}
 
+      - name: Configure Git
+        run: |
+          git config user.name "github-actions"
+          git config user.email "[email protected]"
+
       - name: Setup Python
         uses: actions/setup-python@v5
         with:
           python-version: "3.12"
 
+      - name: Get previous version
+        id: get_previous_version
+        run: |
+          previous_version=$(git tag --sort=-version:refname | sed -n '2p')
+          echo "previous_version=${previous_version}" >> $GITHUB_OUTPUT
+
+      - name: Update changelog
+        run: |
+          ./scripts/update_changelog.sh "${{ steps.get_previous_version.outputs.previous_version }}" "v${{ inputs.version }}"
+
       - name: Install dependencies
         run: |
           pip install pydoc-markdown mkdocs
@@ -46,8 +59,9 @@ jobs:
         run: |
           pydoc-markdown
           mkdocs build
-          
-      - name: Publish docs
-        if: ${{ inputs.publish }}
+
+      - name: Push changes to release branch
         run: |
-          mkdocs gh-deploy
+          git add docs/
+          git commit -m "Update docs for v${{ inputs.version }}"
+          git push origin ${{ inputs.branch }}

.github/workflows/create-github-release.yml

@@ -34,10 +34,9 @@ jobs:
       - name: Generate Changelog
         id: changelog
         run: |
+          changelog=$(./scripts/get_changelog.sh "${{ steps.get_previous_version.outputs.previous_version }}" "v${{ inputs.version }}")
           echo "CHANGELOG<<EOF" >> $GITHUB_OUTPUT
-          echo "## What's Changed" >> $GITHUB_OUTPUT
-          git log --pretty=format:"* %s" "v${{ steps.get_previous_version.outputs.previous_version }}..v${{ inputs.version }}" | \
-          grep -E ".*\(#[0-9]+\).*$" >> $GITHUB_OUTPUT
+          echo -e "$changelog" >> $GITHUB_OUTPUT
           echo "EOF" >> $GITHUB_OUTPUT
 
       - name: Create GitHub Release

.github/workflows/publish-docs.yml

@@ -0,0 +1,26 @@
+name: Publish Docs
+
+on:
+  workflow_dispatch:
+
+jobs:
+  publish-docs:
+    runs-on: ["ubuntu-latest"]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.ref }}
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          pip install pydoc-markdown mkdocs
+
+      - name: Publish docs
+        run: |
+          mkdocs gh-deploy

.github/workflows/release.yml

@@ -40,6 +40,15 @@ jobs:
           git config user.name "github-actions"
           git config user.email "[email protected]"
 
+      - name: Setup GitHub CLI
+        run: |
+          type -p curl >/dev/null || (sudo apt update && sudo apt install curl -y)
+          curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg \
+          && sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg \
+          && echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null \
+          && sudo apt update \
+          && sudo apt install gh -y
+
       - name: Create Release Branch
         id: create_release_branch
         run: |
@@ -126,8 +135,8 @@ jobs:
     uses: ./.github/workflows/build-docs.yml
     if: ${{ inputs.build_docs == true }}
     with:
-      publish: ${{ inputs.test == false }}
       branch: ${{ needs.create-release-branch.outputs.RELEASE_BRANCH }} 
+      version: ${{ inputs.version }}
     secrets: inherit
 
   create-github-release:

scripts/get_changelog.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+# Initialize changelog with header
+CHANGELOG="## What's Changed"
+
+# Get commits with PR numbers and append them to changelog
+while IFS= read -r line; do
+    CHANGELOG="${CHANGELOG}\n${line}"
+done < <(git log --pretty=format:"* %s" "$1..$2" | grep -E ".*\(#[0-9]+\).*$")
+
+# Output in GitHub Actions format
+echo -e "$CHANGELOG"

scripts/update_changelog.sh

@@ -0,0 +1,28 @@
+#!/bin/bash
+
+# Get the new changes from get_changelog.sh
+changelog=$(./scripts/get_changelog.sh "$1" "$2")
+
+# Get today's date in the format Month DD, YYYY
+today=$(date "+%B %d, %Y")
+
+# Create the new section with version and date
+new_section="## v$3 - ${today}\n\n### Features and improvements\n\n${changelog}\n"
+
+# Create a temporary file
+temp_file=$(mktemp)
+
+# Read the first line (# Changelog) and write it to temp file
+head -n 1 docs/changelog.md > "$temp_file"
+
+# Add a blank line after the header
+echo "" >> "$temp_file"
+
+# Add the new section
+echo -e "$new_section" >> "$temp_file"
+
+# Add the rest of the original file (skipping the first line)
+tail -n +2 docs/changelog.md >> "$temp_file"
+
+# Replace the original file with the new content
+mv "$temp_file" docs/changelog.md