Merge remote-tracking branch 'origin/main' into 22-feature-request-incremental-tts-streaming-with-text-chunking

Author: roryeckel

.github/workflows/docker-image-pr.yml

@@ -2,30 +2,45 @@ name: Docker Image PR Build
 
 on:
   pull_request:
+    types: [opened, synchronize, reopened]
     branches: [ "main" ]
 
 jobs:
-  build:
+  build-and-push:
+    # Only run for PRs from the same repository (security measure)
+    if: github.event.pull_request.head.repo.full_name == github.repository
     runs-on: ubuntu-latest
     permissions:
       contents: read
-      packages: read
+      packages: write
 
     steps:
     - uses: actions/checkout@v4
 
+    - name: Set up Docker Buildx
+      uses: docker/setup-buildx-action@v3
+
+    - name: Log in to GitHub Container Registry
+      uses: docker/login-action@v3
+      with:
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
     - name: Extract metadata (tags, labels) for Docker
       id: meta
       uses: docker/metadata-action@v5
       with:
         images: ghcr.io/${{ github.repository }}
         tags: |
-          type=sha
+          type=raw,value=pr-${{ github.event.number }}
 
-    - name: Build Docker image
+    - name: Build and push Docker image
       uses: docker/build-push-action@v5
       with:
         context: .
-        push: false
+        push: true
         tags: ${{ steps.meta.outputs.tags }}
         labels: ${{ steps.meta.outputs.labels }}
+        cache-from: type=gha
+        cache-to: type=gha,mode=max

.github/workflows/pr-cleanup.yml

@@ -0,0 +1,80 @@
+name: PR Docker Cleanup
+
+on:
+  pull_request:
+    types: [closed]
+    branches: [ "main" ]
+
+jobs:
+  cleanup:
+    # Only run for PRs from the same repository (security measure)
+    if: github.event.pull_request.head.repo.full_name == github.repository
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+    - name: Log in to GitHub Container Registry
+      uses: docker/login-action@v3
+      with:
+        registry: ghcr.io
+        username: ${{ github.actor }}
+        password: ${{ secrets.GITHUB_TOKEN }}
+
+    - name: Delete PR Docker image
+      continue-on-error: true
+      run: |
+        # Convert repository name to lowercase for Docker registry
+        REPO_LOWER=$(echo "${{ github.repository }}" | \
+          tr '[:upper:]' '[:lower:]')
+        PACKAGE_NAME=$(basename ${REPO_LOWER})
+        TAG_NAME="pr-${{ github.event.number }}"
+
+        echo "Attempting to delete tag: ${TAG_NAME} for package: ${PACKAGE_NAME}"
+
+        # Determine the correct API base path based on repository owner type
+        OWNER_TYPE="${{ github.repository_owner_type }}"
+        OWNER="${{ github.repository_owner }}"
+        if [ "$OWNER_TYPE" = "Organization" ]; then
+          API_BASE="orgs/${OWNER}"
+        else
+          API_BASE="users/${OWNER}"
+        fi
+
+        echo "Using API base path: ${API_BASE}"
+        
+        # Get all versions of the package with error handling
+        API_URL="https://api.github.com/${API_BASE}/packages/container/${PACKAGE_NAME}/versions"
+        RESPONSE=$(curl -sSf \
+          -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+          -H "Accept: application/vnd.github+json" \
+          "${API_URL}" 2>&1)
+        CURL_EXIT_CODE=$?
+        if [ $CURL_EXIT_CODE -ne 0 ]; then
+          echo "Error: Failed to fetch package versions from GitHub API. Response:"
+          echo "$RESPONSE"
+          exit $CURL_EXIT_CODE
+        fi
+        VERSIONS=$(echo "$RESPONSE" | \
+          jq -r '.[] | select(.metadata.container.tags[]? == "'${TAG_NAME}'") | .id')
+
+        if [ -n "$VERSIONS" ]; then
+          for VERSION_ID in $VERSIONS; do
+            echo "Deleting version ID: $VERSION_ID with tag: ${TAG_NAME}"
+            DELETE_URL="${API_URL}/${VERSION_ID}"
+            DELETE_RESPONSE=$(curl -sSf -X DELETE \
+              -H "Authorization: Bearer ${{ secrets.GITHUB_TOKEN }}" \
+              -H "Accept: application/vnd.github+json" \
+              "${DELETE_URL}" 2>&1)
+            DELETE_EXIT_CODE=$?
+            if [ $DELETE_EXIT_CODE -eq 0 ]; then
+              echo "Successfully deleted Docker image version: ${VERSION_ID}"
+            else
+              echo "Warning: Failed to delete version ID: $VERSION_ID. Response:"
+              echo "$DELETE_RESPONSE"
+            fi
+          done
+        else
+          echo "No Docker image found for tag: ${TAG_NAME}, nothing to clean up"
+        fi

README.md

@@ -284,6 +284,32 @@ We follow specific tagging conventions for our Docker images. These tags help in
 
 - **`major.minor version`**: Tags that follow the `major.minor` format (e.g., `0.3`) represent a range of patch-level updates within the same minor version series. These tags are useful for users who want to stay updated with bug fixes and minor improvements without upgrading to a new major or minor version.
 
+- **`pr-{number}`**: Pull request tags (e.g., `pr-123`) are automatically created for each pull request to allow testing of proposed changes before they are merged. These tags are automatically cleaned up when the pull request is closed or merged.
+
+#### 9. Pull Request Docker Images
+
+For contributors and maintainers who want to test changes from pull requests before they are merged, we automatically build and push Docker images for each pull request.
+
+**How it works:**
+- When a pull request is opened or updated, a Docker image is automatically built and pushed with the tag `pr-{pr_number}`
+- Only pull requests from the main repository (not forks) will trigger image builds for security reasons
+- When a pull request is closed or merged, the corresponding Docker image is automatically deleted to save storage space
+
+**Using PR images:**
+```bash
+# Example: Test PR #123
+docker run --rm -p 10300:10300 ghcr.io/roryeckel/wyoming_openai:pr-123
+
+# Or with docker-compose, update your docker-compose.yml:
+# image: ghcr.io/roryeckel/wyoming_openai:pr-123
+```
+
+**For contributors:**
+- PR images are built automatically - no action needed
+- Images are available within minutes of opening/updating a PR
+- Check the Actions tab to see build status
+- Images are automatically cleaned up when the PR is closed
+
 ### General Deployment Steps
 
 1. **Start Services**: Run the appropriate Docker Compose command based on your deployment option.