[CI/CD] WIP: Re-use Workflows to Ensure GitHub Pages is built after every pre-release - Cleanup Workflow Naming Inconsistency - Remove 'release.yaml' workflow

.github/workflows/close-discussion.yaml

@@ -0,0 +1,59 @@
+name: Close Discussion on PR Merge
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  closeDiscussion:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v2
+
+      - name: Check if PR was merged
+        if: github.event.pull_request.merged == true
+        run: echo "PR was merged"
+
+      - name: Extract Discussion Number & Close If any Where Found
+        # Make the running bash script behave like it would when ran locally
+        # by default GitHub actions has 'set -e', which'll make the whole step fail
+        # upon small things, like grep not finding any matches.. which sometimes
+        # we do want this behavior, so we set shell to be 'bash {0}' to bring back control.
+        # reference: https://stackoverflow.com/questions/73066461/github-actions-why-an-intermediate-command-failure-in-shell-script-would-cause
+        shell: bash {0}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        if: github.event.pull_request.merged == true
+        id: extract-discussion
+        run: |
+          output_str=$(cat <<DELIMITER
+             TODO:
+               Use GitHub's GraphQL to query the Discussion by ID, therefore checking if ID is for a discussion or not.
+               Then make a new comment to it, wait until it's created, and maybe wait additional seconds to make sure everything works great.
+               Then mark the newly created comment on discussion as the answer to discussion, so the discussion is "closed" so to speak.
+               Reference:
+                 - https://github.com/orgs/community/discussions/43
+                 - https://github.com/orgs/community/discussions/43#discussioncomment-399047
+                 - https://docs.github.com/en/graphql/guides/using-the-graphql-api-for-discussions
+          DELIMITER)
+          echo "$output_str"
+          exit 1
+          #pr_body="${{ github.event.pull_request.body }}"
+
+          #discussion_ids=$(echo "$pr_body" | grep -i -Po '^\s*(-|\d+\.)?\s*(Resolve(s|d)?)\s*#\d+\s*$|^\s*(-|\d+\.)?\s*(Fix(es|ed)?)\s*#\d+\s*$|^\s*(-|\d+\.)?\s*(Close(s|d)?)\s*#\d+\s*$' | awk -F '#' '{print $2}')
+
+          #echo "IDs Array:     ${discussion_ids[@]}"
+
+          #if [ -z "$discussion_ids" ]; then
+          #  echo "No discussion IDs found."
+          #  exit 0
+          #fi
+
+          #for (( i=0; i<${number_of_ids}; i++ )); do
+          #  discussion_id=${discussion_ids_arr[$i]}
+          #  echo "$discussion_id"
+          #  curl -X PATCH -H "Authorization: token $GITHUB_TOKEN" \
+          #       -d '{"state": "closed"}' \
+          #       "https://api.github.com/repos/${{ github.repository }}/discussions/$discussion_id"
+          #done

.github/workflows/createchangelog.yaml

@@ -0,0 +1,124 @@
+name: Update changelog.md on Release
+
+on:
+  workflow_dispatch: # Manual trigger added
+  workflow_call: # Make this Working a re-usable one (can be called form another workflow)
+
+jobs:
+  update-changelog-file:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        # Make sure to get latest commits, like the one committed by the previous job in jobs list.
+        # reference: https://github.com/orgs/community/discussions/110853
+        with:
+          fetch-tags: 'true'
+          submodules: 'recursive'
+          ref: main # Always pull from & push to 'main' branch, as without doing so, it'll cause some problems.
+
+      - name: Get all releases and update changelog.md file
+        run: |
+          # Initialize some values
+          changelog_path="docs/changelog.md"
+          gh release list --exclude-drafts --json tagName,name,isLatest,isPrerelease --limit 1000000 > releases.txt
+          declare -r number_of_releases=$(cat releases.txt | grep -Po '"tagName"' | wc --lines)
+
+          # Clear the contents of changelog file
+          echo "" > $changelog_path
+
+          # Write some Initial Content to changelog file
+          echo "# Changelog" >> $changelog_path
+          echo "" >> $changelog_path
+          echo "WinUtil change log received from GitHub Releases, it's autogenerated using GitHub Actions." >> $changelog_path
+          echo "" >> $changelog_path
+          echo "!!! warning \"Important\"" >> $changelog_path
+          echo "" >> $changelog_path
+          echo "     This file **SHOULD NOT** be edited directly, any PRs that tries changing it directly will either be requested on not changing it, or said PR **will get rejected**." >> $changelog_path
+          echo "" >> $changelog_path
+
+          # Make array for git tag names
+          tag_arr=()
+          cat releases.txt | grep -Po '"tagName":\s*.*?[^\\]"' | awk -F ':' '{print $2}' | sed s/\"//g > tags_list.txt
+          while read -r line; do
+            tag_arr+=("$line")
+          done < tags_list.txt
+
+          # Make array for releases names
+          name_arr=()
+          cat releases.txt | grep -Po '"name":\s*.*?[^\\]"' | awk -F ':' '{print $2}' | sed s/\"//g > releases_names_list.txt
+          while read -r line; do
+            name_arr+=("$line")
+          done < releases_names_list.txt
+
+          # Make array for isPrerelease
+          isprerelease_arr=()
+          cat releases.txt | grep -Po '"isPrerelease":\s*(false|true)' | awk -F ':' '{print $2}' | sed s/\"//g > isprerelease_list.txt
+          while read -r line; do
+            isprerelease_arr+=("$line")
+          done < isprerelease_list.txt
+
+          # Make array for isLatest
+          islatest_arr=()
+          cat releases.txt | grep -Po '"isLatest":\s*(false|true)' | awk -F ':' '{print $2}' | sed s/\"//g > islatest_list.txt
+          while read -r line; do
+            islatest_arr+=("$line")
+          done < islatest_list.txt
+
+          # Debug Output
+          echo "Tag Array: " ${tag_arr[@]}
+          echo "Array Length: " ${#tag_arr[@]}
+          echo ""
+
+          echo "Release Name Array: " ${name_arr[@]}
+          echo "Array Length: " ${#name_arr[@]}
+          echo ""
+
+          echo "IsPrerelease Array: " ${isprerelease_arr[@]}
+          echo "Array Length: " ${#isprerelease_arr[@]}
+          echo ""
+
+          echo "IsLatest Array: " ${islatest_arr[@]}
+          echo "Array Length: " ${#islatest_arr[@]}
+          echo ""
+
+          # Exit when this impossible condition is met (just to be safe)
+          if [[ ! (${#tag_arr[@]}==${#name_arr[@]} && ${#tag_arr[@]}==${#isprerelease_arr[@]} && ${#tag_arr[@]}==${#islatest_arr[@]} ) ]] ; then
+            echo "Impossible Condition has been met, the Name Array Length Does Not match Tag Array Length, exiting..."
+            exit 1
+          fi
+
+          # Main loop that does the heavy lifting (Content Generation)
+          for (( i=0; i<${number_of_releases}; i++ ));
+          do
+            # The Variables to use on each iteration
+            tag=${tag_arr[$i]}
+            name=${name_arr[$i]}
+            isprerelease=${isprerelease_arr[$i]}
+            islatest=${islatest_arr[$i]}
+            body=$(gh release view "$tag" --json body --jq .body) || { echo "Failed to fetch release body for $tag"; exit 1; }
+
+            # The generation of changelog file contents
+            echo "# $name" >> $changelog_path
+            echo "" >> $changelog_path
+            echo "$body" >> $changelog_path
+            echo "" >> $changelog_path
+          done
+
+          # Make http(s) links clickable by converting any links to a format understandable by Markdown
+          sed -ri 's/(https?:\/\/.*?\/(pull|compare)\/([^ \t\r\n]+))/\[\3\](\1)/g' $changelog_path
+          sed -ri 's/\[([0-9]+)\]\((https?:\/\/.*?\/pull\/[^ \t\r\n]+)\)/\[#\1\]\(\2\)/g' $changelog_path
+          sed -ri 's/@([^ \t\r\n]+)/[@\1](https:\/\/github\.com\/\1)/g' $changelog_path
+        env:
+          GH_TOKEN: ${{ github.token }}
+
+      - name: Commit and Push Changes
+        run: |
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+          git add docs/changelog.md
+          git commit -m "Update changelog.md with all releases"
+          git push
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/github-pages.yaml

@@ -0,0 +1,41 @@
+name: GitHub Pages Deploy
+on:
+  release:
+    types: [edited, deleted] # Make sure changelog is up-to-date by updating it, and building GitHub Pages.
+  workflow_dispatch: # Manual trigger added
+  workflow_call: # Make this Working a re-usable one (can be called form another workflow)
+
+permissions:
+  contents: write
+
+jobs:
+  update-changelog:
+    uses: ./.github/workflows/createchangelog.yaml
+
+  bulid-deploy-gh-pages:
+    # Make sure 'update-changelog' run first, then run this job afterward
+    needs: update-changelog
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v4
+        # Make sure to get latest commits, like the one committed by the previous job in jobs list.
+        # reference: https://github.com/orgs/community/discussions/110853
+        with:
+          fetch-tags: 'true'
+          submodules: 'recursive'
+          ref: main # Always pull from & push to 'main' branch, as without doing so, it'll cause some problems.
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: 3.x
+
+      - name: Install Additional Python Dependencies
+        run: |
+          pip install mkdocs-material
+          pip install pillow cairosvg
+
+      - name: Build using MkDocs & Deploy to GitHub Pages
+        run: mkdocs gh-deploy --force