Update pages.yml

stephbuon · web-flow · commit 8a8219ae5f97 · 2025-08-16T16:44:21.000-05:00
diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml
@@ -6,7 +6,7 @@ on:
   workflow_dispatch:
 
 permissions:
-  contents: read
+  contents: write
   pages: write
   id-token: write
 
@@ -28,54 +28,66 @@ jobs:
           sudo apt-get update
           sudo apt-get install -y pandoc jq
 
-      # Prefer an existing docs/index.html; only generate from README if missing.
+      - id: ensure_license
+        name: Ensure MIT License exists (and mark if created)
+        run: |
+          if [ ! -f LICENSE ]; then
+            YEAR=$(date +%Y)
+            printf '%s\n' "MIT License" "" "Copyright (c) $YEAR Steph Buongiorno" "" "Permission is hereby granted, free of charge, to any person obtaining a copy" "of this software and associated documentation files (the \"Software\"), to deal" "in the Software without restriction, including without limitation the rights" "to use, copy, modify, merge, publish, distribute, sublicense, and/or sell" "copies of the Software, and to permit persons to whom the Software is" "furnished to do so, subject to the following conditions:" "" "The above copyright notice and this permission notice shall be included in all" "copies or substantial portions of the Software." "" "THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR" "IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY," "FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE" "AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER" "LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM," "OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE" "SOFTWARE." > LICENSE
+            echo "MIT License generated."
+            echo "created=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "LICENSE file already exists — skipping generation."
+            echo "created=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Commit LICENSE to repo (first time only)
+        if: steps.ensure_license.outputs.created == 'true'
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+          git add LICENSE
+          git commit -m "Add MIT LICENSE (auto-generated)"
+          git push
+
       - id: build_page
-        name: Build docs/index.html (prefer existing; fallback to README)
+        name: Build index.html at root (prefer existing; fallback to README) with highlighted code
         env:
           REPO_HTML_TITLE: ${{ github.repository }}
         run: |
           set -e
-          mkdir -p docs
           GENERATED=0
 
-          if [ -f docs/index.html ]; then
-            echo "Keeping existing docs/index.html (not regenerating)."
+          if [ -f index.html ]; then
+            echo "Keeping existing index.html (not regenerating)."
           elif [ -f README.md ]; then
-            echo "Generating docs/index.html from README.md..."
-            pandoc README.md -f markdown -t html -s -o docs/index.html --metadata title="$REPO_HTML_TITLE"
+            echo "Generating index.html from README.md with syntax highlighting..."
+            pandoc README.md -f markdown -t html -s               --highlight-style=tango               -o index.html               --metadata title="$REPO_HTML_TITLE"
             GENERATED=1
           else
-            echo "No docs/index.html or README.md found; writing minimal page."
-            printf '%s\n' \
-              '<!doctype html><html><head><meta charset="utf-8"><title>Site</title></head><body>' \
-              '<h1>Site</h1>' \
-              '<p>No README.md found. Add one and push to regenerate this page.</p>' \
-              '</body></html>' \
-              > docs/index.html
+            echo "No index.html or README.md found; writing minimal page."
+            printf '%s\n' '<!doctype html><html><head><meta charset="utf-8"><title>Site</title></head><body>' '<h1>Site</h1>' '<p>No README.md found. Add one and push to regenerate this page.</p>' '</body></html>' > index.html
             GENERATED=1
           fi
 
-          # Ensure Arial font is applied, even on a custom index.html
-          if grep -qi '</head>' docs/index.html; then
-            sed -i 's|</head>|<style>body{font-family:Arial, Helvetica, sans-serif;} h1,h2,h3,h4,h5,h6{font-family:Arial, Helvetica, sans-serif;}</style></head>|' docs/index.html
+          # Inject GitHub-like CSS for code blocks + base font without sed (avoid escaping issues)
+          CSS_BLOCK='<style>body{font-family:Arial,Helvetica,sans-serif} h1,h2,h3,h4,h5,h6{font-family:Arial,Helvetica,sans-serif} pre code{display:block;padding:.75em;background:#f6f8fa;border-radius:6px;font-size:90%;overflow:auto} code{font-family:ui-monospace,SFMono-Regular,Menlo,Monaco,Consolas,\"Liberation Mono\",\"Courier New\",monospace}</style>'
+          if grep -qi '</head>' index.html; then
+            awk -v css="$CSS_BLOCK" 'BEGIN{IGNORECASE=1} { if (!done && match(tolower($0), /<\/head>/)) { sub(/<\/head>/, css"</head>"); done=1 } print }' index.html > index.html.tmp
+            mv index.html.tmp index.html
           else
-            # Wrap bare content with a head + Arial
             TMP=$(mktemp)
-            printf '%s\n' \
-              '<!doctype html><html><head><meta charset="utf-8">' \
-              '<style>body{font-family:Arial, Helvetica, sans-serif;} h1,h2,h3,h4,h5,h6{font-family:Arial, Helvetica, sans-serif;}</style>' \
-              '</head><body>' \
-              > "$TMP"
-            cat docs/index.html >> "$TMP"
+            printf '%s\n' '<!doctype html><html><head><meta charset="utf-8">' "${CSS_BLOCK}" '</head><body>' > "$TMP"
+            cat index.html >> "$TMP"
             printf '%s\n' '</body></html>' >> "$TMP"
-            mv "$TMP" docs/index.html
+            mv "$TMP" index.html
           fi
 
-          # Expose whether we generated from README/minimal (1) or kept existing (0)
           echo "generated=$GENERATED" >> "$GITHUB_OUTPUT"
 
-      # Append citation ONLY when we generated the page from README/minimal
-      - name: Append suggested citation (written + BibTeX) + repo metadata
+      - name: Append License, Suggested Citation, BibTeX, and repo metadata
         if: steps.build_page.outputs.generated == '1'
         env:
           GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -89,12 +101,8 @@ jobs:
           LAST_UPDATE=$(git log -1 --format=%cI || date -u +%Y-%m-%dT%H:%M:%SZ)
           YEAR=$(date -u -d "$LAST_UPDATE" +%Y 2>/dev/null || date -u +%Y)
 
-          # Collect contributor logins (exclude bots/ghost)
-          logins=$(curl -s -H "Authorization: Bearer $GH_TOKEN" \
-            "https://api.github.com/repos/$REPO/contributors?per_page=100&anon=false" \
-            | jq -r '.[] | select((.type // "") != "Bot") | select(.login != "ghost") | .login' | sort -fu)
+          logins=$(curl -s -H "Authorization: Bearer $GH_TOKEN"             "https://api.github.com/repos/$REPO/contributors?per_page=100&anon=false"             | jq -r '.[] | select((.type // "") != "Bot") | select(.login != "ghost") | .login' | sort -fu)
 
-          # Map to display names (fallback to login), skip Steph to keep her first
           names=""
           for u in $logins; do
             name=$(curl -s -H "Authorization: Bearer $GH_TOKEN" "https://api.github.com/users/$u" | jq -r '.name // empty')
@@ -105,20 +113,17 @@ jobs:
           done
           names_sorted=$(printf "%b" "$names" | awk 'NF' | sort -fu)
 
-          # Suggested (written) citation
           citation_written="Steph Buongiorno"
           if [ -n "$names_sorted" ]; then
             citation_written="$citation_written; $(echo "$names_sorted" | paste -sd ', ' -)"
           fi
           citation_written="$citation_written. $REPO_NAME. $YEAR. Available at: $REPO_URL"
 
-          # Proper BibTeX authors: "A and B and C"
           authors_bibtex="Steph Buongiorno"
           if [ -n "$names_sorted" ]; then
             authors_bibtex="$authors_bibtex and $(echo "$names_sorted" | paste -sd ' and ' -)"
           fi
 
-          # BibTeX entry as a shell variable (YAML-safe)
           bibtex="@misc{$REPO_NAME-$YEAR,
           author = {$authors_bibtex},
           title = {$REPO_NAME},
@@ -127,23 +132,7 @@ jobs:
           note = {Last updated: $LAST_UPDATE}
           }"
 
-          # Append both to index.html
-          printf '%s\n' \
-            '' \
-            '<hr>' \
-            '<h2>Suggested Citation</h2>' \
-            "<p>$citation_written</p>" \
-            '' \
-            '<h3>BibTeX</h3>' \
-            '<pre><code>' \
-            "$bibtex" \
-            '</code></pre>' \
-            '' \
-            '<h3>Repository</h3>' \
-            "<p><em>$REPO_NAME</em><br>" \
-            "<a href=\"$REPO_URL\">$REPO_URL</a><br>" \
-            "<strong>Last updated:</strong> $LAST_UPDATE</p>" \
-            >> docs/index.html
+          printf '%s\n' '' '<hr>' '<h2>License</h2>' '<p>This project is licensed under the <a href="LICENSE">MIT License</a>.</p>' '' '<h2>Suggested Citation</h2>' "<p>$citation_written</p>" '' '<h3>BibTeX</h3>' '<pre><code>' "$bibtex" '</code></pre>' '' '<h3>Repository</h3>' "<p><em>$REPO_NAME</em><br>" "<a href=\"$REPO_URL\">$REPO_URL</a><br>" "<strong>Last updated:</strong> $LAST_UPDATE</p>" >> index.html
 
       - name: Upload site artifact
         uses: actions/upload-pages-artifact@v3
@@ -163,3 +152,4 @@ jobs:
 
 
 
+
