Merge a2192ed into 3585b78

.github/workflows/branch-delete-cleanup.yml

@@ -0,0 +1,28 @@
+name: Branch Deleted
+on: delete
+jobs:
+  delete:
+    if: github.event.ref_type == 'branch'
+
+    env:
+      GIT_BRANCH: ${GITHUB_BASE_REF:-${GITHUB_REF#refs/heads/}}      
+
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clean up
+        run: |
+          echo "Clean up for branch ${{ env.GIT_BRANCH }}"
+
+      - name: Get current published documentation
+        uses: actions/checkout@v2
+        with:
+          ref: gh-pages
+
+      - name: Remove branches draft docs
+        run: |
+          echo rm -rf ${{ env.GIT_BRANCH }}
+
+      - name: Save updated docs
+        uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Removed Draft Docs for ${{ env.GIT_BRANCH }}

.github/workflows/gh-pages.yml

@@ -1,42 +1,34 @@
 name: GitHub Pages
 
-on: 
-  push:
-    branches:
-      - main  
-  pull_request:
-    paths:
-      - 'book/src/**'
-      - '**.md'
-      - 'LICENSE-APACHE'
-      - 'LICENSE-MIT'
-      - 'src/jormungandr/jormungandr-lib/src/interfaces/block0_configuration/BLOCKCHAIN_CONFIGURATION_DOCUMENTED_EXAMPLE.yaml'
-      - 'src/jormungandr/jormungandr-lib/src/interfaces/CONFIG_PARAMS_DOCUMENTED_EXAMPLE.yaml'
-      - 'book.toml'
-      - 'Makefile.toml'
-      - 'Makefiles/docs.toml'
+on: [push, pull_request]
 
 jobs:
   deploy:
     runs-on: ubuntu-latest
-    env:
-      PUBLISH_DOCS: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
     permissions:
       contents: write
     concurrency:
       group: ${{ github.workflow }}-${{ github.ref }}
     steps:
-      - uses: actions/checkout@v3
+      - name: Checkout The Code
+        uses: actions/checkout@v3
 
+      - name: Set env
+        run: |
+          GIT_BRANCH=${GITHUB_HEAD_REF:-${GITHUB_REF#refs/heads/}}
+          echo "GIT_BRANCH=$GIT_BRANCH" >> $GITHUB_ENV            
+    
       - name: Build Docs
         uses: docker://ghcr.io/input-output-hk/catalyst-gh-tools:v1.1
         with:
           entrypoint: cargo
           args: make build-docs
 
-      - name: Deploy
-        if: ${{ env.PUBLISH_DOCS }}
+      # On PUSH or PR we deploy docs to a sub-directory named after the branch.
+      # This lets us review the docs as rendered, and not just the markdown.
+      - name: Deploy Docs
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./book/html
+          publish_dir: ./book/html
+          destination_dir: ${{ env.GIT_BRANCH }}

book/src/05_unified_platform/01_catalyst-cardano-bridge/00.md

@@ -1,4 +1,4 @@
-# Overview
+# Catalyst-Cardano Bridge
 
 The Catalyst-Cardano bridge is a custom bridge interface between Catalyst and a Cardano Node.
 It tracks data relevant to the unified Catalyst system, as it appears on the Cardano network, in real-time.