Add demo workflow

.github/workflows/demo.yml

@@ -0,0 +1,168 @@
+name: Demo
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types: [labeled, opened, synchronize]
+    paths:
+      - ".github/workflows/demo.yml"
+
+env:
+  TERM: "xterm-256color"
+  COLORTERM: "truecolor"
+  LANG: "en_US.UTF-8"
+  ATMOS_LOGS_LEVEL: "Info"
+  TERRAFORM_VERSION: "1.9.7"
+
+jobs:
+  prepare:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Get Atmos version
+        id: get-version
+        run: |
+          VERSION=$(curl -s https://api.github.com/repos/cloudposse/atmos/releases/latest | jq -r .tag_name)
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+    outputs:
+      version: ${{ steps.get-version.outputs.version }}
+
+  screengrabs:
+    needs: [prepare]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y aha util-linux make jq bat
+          sudo ln -s /usr/bin/batcat /usr/bin/bat
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Install Atmos
+        uses: jaxxstorm/[email protected]
+        with:
+          repo: cloudposse/atmos
+          tag: ${{ needs.prepare.outputs.version }}
+          chmod: 0755
+          extension-matching: disable
+          rename-to: atmos
+
+      - uses: hashicorp/setup-terraform@v3
+        with:
+          terraform_version: ${{ env.TERRAFORM_VERSION }}
+          terraform_wrapper: false
+
+      - name: Run make build-all install
+        run: |
+          make -C demo/screengrabs build-all install
+          git add -A
+          git status
+
+      - name: Create or update PR
+        uses: peter-evans/create-pull-request@v7
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch: "chore/update-build-screengrabs-for-${{ needs.prepare.outputs.version }}"
+          title: "Update screengrabs for ${{ needs.prepare.outputs.version }}"
+          delete-branch: true
+          sign-commits: true
+          commit-message: |
+            chore: update screengrabs for ${{ needs.prepare.outputs.version }}
+          body: |
+            This PR updates the screengrabs for Atmos version ${{ needs.prepare.outputs.version }}.
+          base: main
+          labels: "no-release"
+
+  vhs:
+    needs: [prepare]
+    runs-on: ubuntu-latest
+    timeout-minutes: 120
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Checkout cloudposse-corp/assets
+        uses: actions/checkout@v4
+        with:
+          repository: cloudposse-corp/assets
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install audio track
+        run: |
+          cp assets/artlist/background-1.mp3 demo/recordings
+
+      - name: Set Swap Space
+        uses: pierotofy/set-swap-space@0404882bc4666c0ff2f6fd8b3d32af69a730183c
+        with:
+          swap-size-gb: 15
+
+      - name: Install Atmos
+        uses: jaxxstorm/[email protected]
+        with:
+          repo: cloudposse/atmos
+          tag: ${{ needs.prepare.outputs.version }}
+          chmod: 0755
+          extension-matching: disable
+          rename-to: atmos
+
+      - uses: hashicorp/setup-terraform@v3
+        with:
+          terraform_version: ${{ env.TERRAFORM_VERSION }}
+          terraform_wrapper: false
+
+      - name: Test Atmos
+        run: |
+          which atmos
+          atmos version
+          atmos --help
+
+      - name: Prepare variables
+        id: vars
+        run: |
+          VERSION="${{ needs.prepare.outputs.version }}"
+          echo "version=${VERSION}" >> $GITHUB_OUTPUT
+          echo "job_name=${JOB_NAME}" >> $GITHUB_OUTPUT
+          echo "branch_name=chore/update-${JOB_NAME}-for-${VERSION}" >> $GITHUB_OUTPUT
+
+      - name: Setup VHS
+        uses: charmbracelet/vhs-action@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          install-fonts: true
+
+      - name: Record screencast
+        run: |
+          demo/recordings/build.sh
+          mv demo/recordings/gif/atmos.gif docs/demo.gif
+
+      - name: Create or update PR
+        uses: peter-evans/create-pull-request@v7
+        id: auto-commit
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ steps.vars.outputs.branch_name }}
+          sign-commits: true
+          commit-message: |
+            chore: update ${{ steps.vars.outputs.job_name }} for ${{ steps.vars.outputs.version }}
+          title: Update ${{ steps.vars.outputs.job_name }} for ${{ steps.vars.outputs.version }}
+          body: |
+            This PR updates the demo gif for ${{ steps.vars.outputs.job_name }} with Atmos version ${{ steps.vars.outputs.version }}.
+          base: main
+          labels: no-release
+
+      - name: Add Image to Job Summary
+        if: steps.auto-commit.outputs.pull-request-operation == 'created' || steps.auto-commit.outputs.pull-request-operation == 'updated'
+        run: |
+          echo "## Demo GIF" >> $GITHUB_STEP_SUMMARY
+          echo "![Demo GIF](https://github.com/${{ github.repository }}/blob/${{ steps.auto-commit.outputs.pull-request-head-sha }}/docs/demo.gif?raw=true)" >> $GITHUB_STEP_SUMMARY
+
+          echo "## Demo Video" >> $GITHUB_STEP_SUMMARY
+          echo "https://github.com/${{ github.repository }}/blob/${{ steps.auto-commit.outputs.pull-request-head-sha }}/demo/recordings/mp4/atmos-with-audio.mp4?raw=true" >> $GITHUB_STEP_SUMMARY
+
+      - name: No changes
+        if: steps.auto-commit.outputs.pull-request-operation == 'none' || steps.auto-commit.outputs.pull-request-operation == 'closed'
+        run: |
+          echo "No changes to demo" >> $GITHUB_STEP_SUMMARY

demo/defaults.tape

@@ -0,0 +1,31 @@
+# VHS Defaults for Recordings and Screenshots
+
+#Set Theme "Monokai Vivid"
+
+# It's not possible to combine named themes, with explicitly defined themes
+Set Theme { "name": "Monokai Vivid", "black": "#121212", "red": "#fa2934", "green": "#98e123", "yellow": "#fff30a", "blue": "#0443ff", "magenta": "#f800f8", "cyan": "#01b6ed", "white": "#ffffff", "brightBlack": "#838383", "brightRed": "#f6669d", "brightGreen": "#b1e05f", "brightYellow": "#fff26d", "brightBlue": "#0443ff", "brightMagenta": "#f200f6", "brightCyan": "#51ceff", "brightWhite": "#ffffff", "background": "#121212", "foreground": "#f9f9f9", "cursor": "#b3b0d6", "selection": "#ffffff"}
+
+Set FontFamily "FiraCode Nerd Font"
+#Set FontFamily "Hack Nerd Font"
+Set FontSize 14
+
+Set TypingSpeed 20ms
+
+Set WindowBar Colorful
+
+Set BorderRadius 8
+
+Set Margin 0
+
+Set Padding 10
+
+# !! WARNING !!
+# Large aspect ratios require more memory to process (and a factor of the framerate)
+# Free-tier GitHub Action runners do not have sufficient memory to process long recordings
+# at a high framerate before crashing. Therefore, for automation purposes we need to keep these small.
+
+# Use standard aspect ratios
+Set Width 1280
+Set Height 720
+
+Set Shell "bash"

demo/recordings/.gitignore

@@ -0,0 +1 @@
+background.mp3

demo/recordings/build.sh

@@ -0,0 +1,90 @@
+#!/usr/bin/env bash
+set -euo pipefail
+
+# ---------------------------------------------------------------------
+# build.sh
+# Executes VHS from the root of the git repository
+# Converts tapes/*.tape to mp4/*.mp4, processes scenes, and generates gifs
+# ---------------------------------------------------------------------
+
+# Resolve absolute paths for key directories
+REPO_ROOT="$(git rev-parse --show-toplevel)"
+TAPES_DIR="$REPO_ROOT/demo/recordings/tapes"
+SCENES_DIR="$REPO_ROOT/demo/recordings/scenes"
+MP4_OUTDIR="$REPO_ROOT/demo/recordings/mp4"
+GIF_OUTDIR="$REPO_ROOT/demo/recordings/gif"
+AUDIO_FILE="$REPO_ROOT/demo/recordings/background.mp3"
+
+# Handle "clean" argument
+if [[ "${1:-}" == "clean" ]]; then
+  echo ">> Cleaning up generated files..."
+  rm -rf "$MP4_OUTDIR" "$GIF_OUTDIR"
+  exit 0
+fi
+
+# Ensure output directories exist
+echo ">> Ensuring $MP4_OUTDIR and $GIF_OUTDIR exist"
+mkdir -p "$MP4_OUTDIR" "$GIF_OUTDIR"
+
+# 1) Convert each tapes/*.tape => mp4/<basename>.mp4
+echo ">> Step 1: Converting $TAPES_DIR/*.tape to $MP4_OUTDIR/*.mp4 via VHS"
+shopt -s nullglob
+TAPEFILES=( "$TAPES_DIR"/*.tape )
+if [[ ${#TAPEFILES[@]} -eq 0 ]]; then
+  echo "No .tape files found in $TAPES_DIR. Exiting."
+  exit 1
+fi
+
+for tape in "${TAPEFILES[@]}"; do
+  base="$(basename "$tape" .tape)"
+  echo "   Processing $tape -> $MP4_OUTDIR/$base.mp4"
+  (cd "$REPO_ROOT" && vhs "$tape" --output "$MP4_OUTDIR/$base.mp4")
+done
+
+# 2) Process scenes/*.txt
+echo ">> Step 2: Building each scene from $SCENES_DIR/*.txt"
+SCENE_FILES=( "$SCENES_DIR"/*.txt )
+if [[ ${#SCENE_FILES[@]} -eq 0 ]]; then
+  echo "No scene text files found in $SCENES_DIR. Skipping scene-building steps."
+  exit 0
+fi
+
+for scene_file in "${SCENE_FILES[@]}"; do
+  scene_name="$(basename "$scene_file" .txt)"
+
+  echo "   Scene: $scene_file => $scene_name"
+
+  # Concatenate scene
+  echo "      Concatenating -> $MP4_OUTDIR/$scene_name.mp4"
+  ffmpeg -f concat -safe 0 -i "$scene_file" -c copy "$MP4_OUTDIR/$scene_name.mp4"
+
+  # Add audio fade
+  echo "      Adding fade audio -> $MP4_OUTDIR/$scene_name-with-audio.mp4"
+  DURATION="$(ffprobe -v error -show_entries format=duration -of csv=p=0 "$MP4_OUTDIR/$scene_name.mp4")"
+  FADE_START=$(( ${DURATION%.*} - 5 ))
+  ffmpeg -i "$MP4_OUTDIR/$scene_name.mp4" -i "$AUDIO_FILE" \
+    -filter_complex "[1:a]afade=t=out:st=${FADE_START}:d=5[aout]" \
+    -map 0:v -map "[aout]" \
+    -c:v copy -c:a aac "$MP4_OUTDIR/$scene_name-with-audio.mp4"
+
+  # Create GIF
+  echo "      Creating GIF -> $GIF_OUTDIR/$scene_name.gif"
+  ffmpeg -y -i "$MP4_OUTDIR/$scene_name-with-audio.mp4" \
+    -vf palettegen "$GIF_OUTDIR/$scene_name-palette.png"
+
+  ffmpeg -i "$MP4_OUTDIR/$scene_name-with-audio.mp4" \
+         -i "$GIF_OUTDIR/$scene_name-palette.png" \
+         -lavfi "fps=10 [video]; [video][1:v] paletteuse" \
+         -y "$GIF_OUTDIR/$scene_name.gif"
+
+  echo "      Done with scene: $scene_name"
+done
+
+echo
+echo ">> Done building scenes!"
+echo "   Segments: $MP4_OUTDIR/<segment>.mp4"
+echo "   Scenes:   $MP4_OUTDIR/<scene>.mp4"
+echo "   Audio:    $MP4_OUTDIR/<scene>-with-audio.mp4"
+echo "   GIFs:     $GIF_OUTDIR/<scene>.gif"
+echo
+echo "Use './build.sh clean' to remove them."