Update README and related documents to include all 9 examples #131
Workflow file for this run
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Deploy Documentation | |
| on: | |
| push: | |
| branches: [ "main" ] | |
| paths: | |
| - 'docs/**' | |
| - '.github/workflows/docs.yml' | |
| tags: | |
| - 'v*' | |
| pull_request: | |
| branches: [ "main" ] | |
| paths: | |
| - 'docs/**' | |
| - '.github/workflows/docs.yml' | |
| # Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages | |
| permissions: | |
| contents: read | |
| 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: | |
| # Build job | |
| build: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: Checkout | |
| uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0 | |
| - name: Install Rust toolchain | |
| uses: dtolnay/rust-toolchain@6d653acede28d24f02e3cd41383119e8b1b35921 # stable | |
| with: | |
| toolchain: stable | |
| - name: Install mdBook | |
| run: | | |
| mkdir bin | |
| curl -sSL https://github.com/rust-lang/mdBook/releases/download/v0.4.40/mdbook-v0.4.40-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin | |
| echo "$GITHUB_WORKSPACE/bin" >> $GITHUB_PATH | |
| - name: Install mdBook Tabs | |
| run: | | |
| cargo install mdbook-tabs | |
| echo "$HOME/.cargo/bin" >> $GITHUB_PATH | |
| - name: Install mdbook-mermaid | |
| run: | | |
| curl -sSL https://github.com/badboy/mdbook-mermaid/releases/download/v0.14.0/mdbook-mermaid-v0.14.0-x86_64-unknown-linux-gnu.tar.gz | tar -xz --directory=bin | |
| echo "$GITHUB_WORKSPACE/bin" >> $GITHUB_PATH | |
| - name: Setup Pages | |
| id: pages | |
| uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0 | |
| - name: Determine version | |
| id: version | |
| run: | | |
| if [[ "${{ github.ref }}" == refs/tags/v* ]]; then | |
| VERSION="${{ github.ref_name }}" | |
| else | |
| VERSION="latest" | |
| fi | |
| echo "version=$VERSION" >> $GITHUB_OUTPUT | |
| echo "Building documentation for version: $VERSION" | |
| - name: Build with mdBook | |
| run: | | |
| cd docs | |
| mdbook build | |
| - name: Download existing GitHub Pages content | |
| run: | | |
| # IMPORTANT: GitHub Pages deployments completely replace the entire site with | |
| # the uploaded artifact. Without this preservation step, deploying a new version | |
| # (e.g., v0.4.0) would delete all previously published versions (e.g., v0.3.0, latest). | |
| # We fetch content from the gh-pages branch and merge it with the new version | |
| # to maintain a complete multi-version documentation site. | |
| echo "Attempting to download existing site content..." | |
| mkdir -p public | |
| # Save current commit for returning later | |
| CURRENT_COMMIT=$(git rev-parse HEAD) | |
| # Try to download existing site as a tarball from gh-pages branch | |
| if git ls-remote --heads origin gh-pages >/dev/null 2>&1; then | |
| echo "gh-pages branch exists, fetching existing content..." | |
| git fetch origin gh-pages:gh-pages || true | |
| git checkout gh-pages -- . 2>/dev/null || echo "No existing gh-pages content" | |
| # Move existing content to public if it exists | |
| if [ -d "wassette" ]; then | |
| cp -r wassette public/ || true | |
| fi | |
| # Return to original commit | |
| git checkout $CURRENT_COMMIT || echo "Could not return to original commit" | |
| else | |
| echo "gh-pages branch does not exist yet, starting fresh" | |
| fi | |
| - name: Prepare versioned output | |
| run: | | |
| # Create directory structure for this version | |
| mkdir -p public/wassette/${{ steps.version.outputs.version }} | |
| # Copy newly built docs to the version directory | |
| cp -r docs/book/* public/wassette/${{ steps.version.outputs.version }}/ | |
| # Create root redirect page (this should NOT be in docs source, only at GitHub Pages root) | |
| cat > public/wassette/index.html << 'EOF' | |
| <!DOCTYPE html> | |
| <html lang="en"> | |
| <head> | |
| <meta charset="UTF-8"> | |
| <meta http-equiv="refresh" content="0; url=latest/"> | |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> | |
| <title>Redirecting to Wassette Documentation</title> | |
| <style> | |
| body { | |
| font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, "Helvetica Neue", Arial, sans-serif; | |
| display: flex; | |
| justify-content: center; | |
| align-items: center; | |
| height: 100vh; | |
| margin: 0; | |
| background-color: #f5f5f5; | |
| } | |
| .message { | |
| text-align: center; | |
| padding: 2rem; | |
| background: white; | |
| border-radius: 8px; | |
| box-shadow: 0 2px 10px rgba(0,0,0,0.1); | |
| } | |
| a { | |
| color: #4183c4; | |
| text-decoration: none; | |
| } | |
| a:hover { | |
| text-decoration: underline; | |
| } | |
| </style> | |
| </head> | |
| <body> | |
| <div class="message"> | |
| <h1>Redirecting to Wassette Documentation</h1> | |
| <p>If you are not redirected automatically, <a href="latest/">click here</a>.</p> | |
| </div> | |
| </body> | |
| </html> | |
| EOF | |
| # Load or create versions.json | |
| if [ -f "public/wassette/versions.json" ]; then | |
| echo "Using existing versions.json" | |
| cp public/wassette/versions.json versions.json.tmp | |
| else | |
| echo "Creating new versions.json" | |
| cp docs/versions.json versions.json.tmp | |
| fi | |
| # Update versions.json with current version | |
| python3 << 'EOF' | |
| import json | |
| version = "${{ steps.version.outputs.version }}" | |
| try: | |
| with open("versions.json.tmp", "r") as f: | |
| data = json.load(f) | |
| except: | |
| data = {"versions": ["latest"], "latest": "latest"} | |
| # Add current version if it's not already in the list | |
| if version not in data["versions"]: | |
| # Insert version after "latest" if it's a tag | |
| if version.startswith("v"): | |
| if "latest" in data["versions"]: | |
| idx = data["versions"].index("latest") + 1 | |
| data["versions"].insert(idx, version) | |
| else: | |
| data["versions"].insert(0, version) | |
| else: | |
| # Ensure "latest" is first | |
| if "latest" not in data["versions"]: | |
| data["versions"].insert(0, "latest") | |
| with open("public/wassette/versions.json", "w") as f: | |
| json.dump(data, f, indent=2) | |
| print(f"Updated versions.json with version: {version}") | |
| print(f"All versions: {data['versions']}") | |
| EOF | |
| echo "Current versions.json:" | |
| cat public/wassette/versions.json | |
| echo "" | |
| echo "Directory structure:" | |
| ls -la public/wassette/ | |
| - name: Upload artifact | |
| uses: actions/upload-pages-artifact@7b1f4a764d45c48632c6b24a0339c27f5614fb0b # v4.0.0 | |
| with: | |
| path: public/wassette | |
| # Deployment job | |
| deploy: | |
| environment: | |
| name: github-pages | |
| url: ${{ steps.deployment.outputs.page_url }} | |
| runs-on: ubuntu-latest | |
| needs: build | |
| if: github.ref == 'refs/heads/main' || startsWith(github.ref, 'refs/tags/v') | |
| steps: | |
| - name: Deploy to GitHub Pages | |
| id: deployment | |
| uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4.0.5 |