Adding colophon page for license, DOI and citation

.github/workflows/adoc_build.yml

@@ -18,24 +18,37 @@
 #   https://github.com/Analog-inc/asciidoctor-action
 #   https://github.com/actions/upload-artifact
 #   https://github.com/actions/download-artifact
+#   https://github.com/action-badges/create-orphan-branch
 #
+#   Custom workflow for pages deployment
+#     
 name: Asciidoctor Build Workflow
 on:
   # manually run workflow
   workflow_dispatch:
-  # trigger on PR event against main (will not run publish job)
+  # trigger on PR event against main branch
   pull_request:
     branches: [ main ]
-  # Trigger on a push to main (a PR is merged), or when a release is
-  # published on github. These will run the publish job.
+  # Trigger on a push on branch except gh-pages branch
   push:
-    branches:
-      - main
+    branches-ignore: [ gh-pages ]
   # Trigger when a GitHub release is published.
   release:
     types:
       - published
-jobs:
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: write
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs: 
   # Job to build cf-conventions.html, cf-conventions.pdf
   build_conventions_and_conformance:
     name: Build cf-conventions and conformance html and pdf
@@ -56,7 +69,11 @@ jobs:
     - name: Copy index.html
       run: |
         sudo cp -p .github/gh-pages/index.html build/
-
+    # Update H1 header
+    - name: Update H1 header
+      run: |
+        PATH_REVISION="${GITHUB_REPOSITORY}/${GITHUB_REF_TYPE}/${GITHUB_REF_NAME}@${GITHUB_SHA:0:7}"
+        sudo sed -i s/Latest/"${PATH_REVISION//\//\\/}"/ build/index.html;
     # Upload artifact containing cf-conventions.html, cf-conventions.pdf
     - name: Save cf-conventions and conformance docs
       uses: actions/upload-artifact@v4
@@ -75,21 +92,43 @@ jobs:
     if: github.event_name != 'pull_request'
     # Wait for the build artifacts to become available
     needs: [build_conventions_and_conformance]
+
+#    # Grant GITHUB_TOKEN the permissions required to make a Pages deployment
+#    permissions:
+#      pages: write      # to deploy to Pages
+#      id-token: write   # to verify the deployment originates from an appropriate source
+
+#    # Deploy to the github-pages environment
+#    environment:
+#      name: github-pages
+#      url: ${{ steps.deployment.outputs.page_url }}
+
     runs-on: ubuntu-latest
     steps:
+      # Checkout repo
+      - uses: actions/checkout@v4
+      # create a new orphan branch if a branch with the given name does not already exist
+      - name: Create Orphan Branch
+        uses: action-badges/[email protected]
+        with:
+          branch-name: 'gh-pages'
       # Checkout gh-pages branch
       - uses: actions/checkout@v4
         with:
           ref: 'gh-pages'
+      - name: Add .nojekyll file if it doesn't exist
+        run: |
+          if [ ! -f .nojekyll ]; then
+            touch .nojekyll
+          fi
       # Will new docs go into root, or into a directory named after the
       # release?
       - name: Determine where the new documents should live
         run: |
           if [[ ${{ github.event_name }} == 'release' ]]; then
-            # ${GITHUB_REF##*/} -> turns refs/tags/vM.m.p into vM.m.p
-            echo "TARGET_DIR=${GITHUB_REF##*/}" >> "$GITHUB_ENV"
+            echo "TARGET_DIR=releases/${GITHUB_REF_NAME}" >> "$GITHUB_ENV"
           else
-            echo "TARGET_DIR=." >> "$GITHUB_ENV"
+            echo "TARGET_DIR=${GITHUB_REF_TYPE}/${GITHUB_REF_NAME}" >> "$GITHUB_ENV"
           fi
       # Obtain the build artifacts from the previous jobs and place them in the
       # build/ directory
@@ -99,13 +138,11 @@ jobs:
           path: build/
       # If we are doing a release, we need to create the release directory
       - name: Make release directory
-        if: github.event_name == 'release'
         run: mkdir -p ${{ env.TARGET_DIR }}
       # If we are not doing a release, let's clean out the previous images
-      # directory in the root directory
+      # directory in the root directory (OLD TO BE DEPRECATED)
       - name: Remove old images directory
-        if: github.event_name != 'release'
-        run: rm -rf ${{ env.TARGET_DIR }}/images
+        run: sudo rm -rf ${{ env.TARGET_DIR }}/images
       - name: Copy conventions and conformance documents
         run: |
           cp -p build/cf-conventions.html ${{ env.TARGET_DIR }}/
@@ -117,12 +154,9 @@ jobs:
       # committed to the gh-pages branch
       - name: Remove artifact directory
         run: rm -rf build/
-      # If we are doing a release, update the index.html file to reflect the new
-      # latest release version.
-      - name: Update release index.html to point to new release
-        if: github.event_name == 'release'
-        run: |
-          sed -i s/Latest/"${GITHUB_REF##*/}"/ ${{ env.TARGET_DIR }}/index.html;
+      # Update root index.html: tree directories, excluding empty ones 
+      - name: Update root index.html
+        run: tree -T ${GITHUB_REPOSITORY} --dirsfirst --prune --noreport -I index.html -I README.md -H . -o index.html
       # Stage all changed files to git
       - name: Add all changes to git
         run: git add --all

.gitignore

@@ -8,4 +8,5 @@ conventions_build/
 conformance.html
 conformance.pdf
 conformance_build/
+build/
 .vscode/