Updated CI for automated publications (#373)

Author: Mr3zee

.github/workflows/docs.yml

@@ -7,8 +7,13 @@ on:
       - '.github/workflows/**'
   workflow_dispatch:
     inputs:
-      version:
-        description: 'Version of library that is being documented'
+      dokka_artifact_url:
+        description: 'URL of Dokka artifact.'
+        required: true
+      dry_run:
+        type: boolean
+        description: "Dry run. If set to true, the action will not actually publish the pages, but will assemble the artifact."
+        default: true
         required: true
 
 permissions:
@@ -90,13 +95,21 @@ jobs:
         run: unzip -O UTF-8 -qq '${{ env.ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }}
 
       - name: Download Dokka
-        uses: actions/download-artifact@v4
-        with:
-          name: dokka-${{ inputs.version }}
-          path: ${{ env.DOKKA_ARTIFACT }}
+        run: |
+          if [ -z "${{ inputs.dokka_artifact_url }}" ]; then
+            echo "'dokka_artifact_url' is not set"
+            exit 1
+          fi
+
+          curl -s -L ${{ inputs.dokka_artifact_url }} -o ${{ env.DOKKA_ARTIFACT }}
+          
+          if [ -z "$(ls | grep -x ${{ env.DOKKA_ARTIFACT }})" ]; then
+            echo "Failed to download Dokka artifact: ${{ inputs.dokka_artifact_url }}"
+            exit 1
+          fi
 
       - name: Unzip Dokka
-        run: unzip -O UTF-8 -qq '${{ env.DOKKA_ARTIFACT }}' -d ${{ env.ASSEMBLE_DIR }}/api
+        run: unzip ${{ env.DOKKA_ARTIFACT }} -d ${{ env.ASSEMBLE_DIR }}/api
 
       - name: Update sitemap.xml
         run: chmod +x updateSitemap.sh && ./updateSitemap.sh ${{ env.ASSEMBLE_DIR }}/sitemap.xml ${{ env.ASSEMBLE_DIR }}/api
@@ -110,7 +123,7 @@ jobs:
           retention-days: 7
 
   deploy:
-    if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main'
+    if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main' && !inputs.dry_run
     environment:
       name: github-pages
       url: ${{ steps.deployment.outputs.page_url }}
@@ -138,7 +151,7 @@ jobs:
         uses: actions/deploy-pages@v4
 
   publish-indexes:
-    if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main'
+    if: github.event_name == 'workflow_dispatch' && github.ref == 'refs/heads/main' && !inputs.dry_run
     needs: [ build, test, assemble, deploy ]
     runs-on: ubuntu-latest
     container:

.github/workflows/dokka.yml

@@ -32,7 +32,7 @@ current_date=$(date +%Y-%m-%d)
 temp_file=$(mktemp)
 
 # Extract the first line from sitemap file (XML header), removing closing urlset tag if present
-head -n 1 "$sitemap_file" | sed -En 's/<\/urlset>//' > "$temp_file"
+head -n 1 "$sitemap_file" | sed -En 's/<\/urlset>//p' > "$temp_file"
 
 # Find all HTML files in the API docs directory recursively
 find "$api_docs_dir" -type f -name "*.html" | while read -r html_file; do