feat: prepare worker-vllm for the hub (#214)

* docs: remove outdated video; remove old info; added missing config for tools * ci: use proper release for dev (pr only) and production (release only) * ci(hub): added openai example; use smollm2 as base model * docs: added conventions to be able to work with ai ide's * chore: remove outdated stuff * chore: update copyright to 2025 * ci: added github permissions * feat: added gpuIds, gputCount and allowedCudaVersions; removed default value for LOAD_FORMAT to check which influence this has on the ui --------- Co-authored-by: Tim Pietrusky <tim.pietrusky@runpod.io>
2025-08-28 10:09:27 +02:00
parent aef1187a30
commit 5f0fc69d75
12 changed files with 940 additions and 472 deletions
@@ -0,0 +1,79 @@
+# Contributing to worker-vllm
+
+## 🚀 Release Process
+
+### Development Workflow
+
+1. **Feature Development**
+
+   ```bash
+   git checkout -b feature/your-feature-name
+   # Make your changes
+   git push origin feature/your-feature-name
+   ```
+
+   - Creates pull request → triggers dev build: `runpod/worker-v1-vllm:dev-feature-your-feature-name`
+
+2. **Main Branch**
+   ```bash
+   git checkout main
+   git merge feature/your-feature-name
+   git push origin main
+   ```
+   - No automatic builds on main (staging area)
+
+### Creating Releases
+
+**Method 1: GitHub UI (Recommended)**
+
+1. Go to [Releases](https://github.com/runpod-workers/worker-vllm/releases)
+2. Click **"Create a new release"**
+3. **Tag version**: `v2.8.0` (with "v" prefix, semantic versioning)
+4. **Target**: `main` branch
+5. **Title**: `Release 2.8.0`
+6. **Description**: Brief changelog
+7. Click **"Publish release"**
+
+**Method 2: Git CLI**
+
+```bash
+git checkout main
+git tag v2.8.0
+git push origin v2.8.0
+```
+
+### What Happens Automatically
+
+✅ **GitHub Release** created (if using Method 1)  
+✅ **Docker Image** built and pushed: `runpod/worker-v1-vllm:v2.8.0`  
+✅ **Documentation** updated with new version references
+
+## 📋 Version Format
+
+- **Format**: `vMAJOR.MINOR.PATCH` (e.g., `v2.8.0`)
+- **With "v" prefix**: Use `v2.8.0` for git tags
+- **Semantic Versioning**: Follow [SemVer](https://semver.org/)
+
+## 🐛 Development
+
+### Running Tests
+
+```bash
+# Update test configuration in .runpod/tests.json
+# Tests run automatically via RunPod platform
+```
+
+### Model Updates
+
+- Update `MODEL_NAME` in `.runpod/tests.json` and `worker-config.json`
+- Ensure model has vLLM support and chat template (for OpenAI compatibility)
+
+### Environment Variables
+
+See [README.md](../README.md) for full list of supported environment variables.
+
+## 🔧 CI/CD Workflows
+
+- **Dev builds**: All pull requests → `dev-<branch-name>` images
+- **Release builds**: Git tags → versioned images + GitHub releases
+- **Manual triggers**: Available in GitHub Actions for emergency releases
@@ -0,0 +1,60 @@
+name: Development
+
+on:
+  pull_request:
+    branches:
+      - "**"
+
+permissions:
+  contents: read
+
+jobs:
+  dev:
+    runs-on: [blacksmith-8vcpu-ubuntu-2204, linux]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Clear space to remove unused folders
+        run: |
+          rm -rf /usr/share/dotnet
+          rm -rf /opt/ghc
+          rm -rf "/usr/local/share/boost"
+          rm -rf "$AGENT_TOOLSDIRECTORY"
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: blacksmith docker layer cache
+        uses: useblacksmith/build-push-action@v1
+        with:
+          setup-only: true
+
+      - name: Set environment variables
+        run: |
+          echo "DOCKERHUB_REPO=${{ vars.DOCKERHUB_REPO || 'runpod' }}" >> $GITHUB_ENV
+          echo "DOCKERHUB_IMG=${{ vars.DOCKERHUB_IMG || 'worker-v1-vllm' }}" >> $GITHUB_ENV
+          echo "HUGGINGFACE_ACCESS_TOKEN=${{ secrets.HUGGINGFACE_ACCESS_TOKEN }}" >> $GITHUB_ENV
+          # Convert branch name to safe docker tag (replace / with -)
+          BRANCH_NAME="${GITHUB_REF##refs/heads/}"
+          SAFE_BRANCH_NAME=$(echo "$BRANCH_NAME" | sed 's/[^a-zA-Z0-9._-]/-/g' | sed 's/--*/-/g')
+          echo "RELEASE_VERSION=dev-${SAFE_BRANCH_NAME}" >> $GITHUB_ENV
+
+      - name: Build and push the images to Docker Hub
+        uses: docker/bake-action@v2
+        with:
+          push: true
+          set: |
+            *.args.DOCKERHUB_REPO=${{ env.DOCKERHUB_REPO }}
+            *.args.DOCKERHUB_IMG=${{ env.DOCKERHUB_IMG }}
+            *.args.RELEASE_VERSION=${{ env.RELEASE_VERSION }}
+            *.args.HUGGINGFACE_ACCESS_TOKEN=${{ env.HUGGINGFACE_ACCESS_TOKEN }}
@@ -0,0 +1,102 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v[0-9]+.[0-9]+.[0-9]+*" # Trigger on version tags like v1.0.0, v2.1.0, etc.
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version to release (e.g., v2.8.0)"
+        required: true
+        type: string
+
+permissions:
+  contents: write # Required for creating GitHub releases
+  packages: write # Required for pushing Docker images (if using GitHub packages)
+
+jobs:
+  release:
+    runs-on: [blacksmith-8vcpu-ubuntu-2204, linux]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Clear space to remove unused folders
+        run: |
+          rm -rf /usr/share/dotnet
+          rm -rf /opt/ghc
+          rm -rf "/usr/local/share/boost"
+          rm -rf "$AGENT_TOOLSDIRECTORY"
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v3
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: blacksmith docker layer cache
+        uses: useblacksmith/build-push-action@v1
+        with:
+          setup-only: true
+
+      - name: Set environment variables
+        run: |
+          echo "DOCKERHUB_REPO=${{ vars.DOCKERHUB_REPO || 'runpod' }}" >> $GITHUB_ENV
+          echo "DOCKERHUB_IMG=${{ vars.DOCKERHUB_IMG || 'worker-v1-vllm' }}" >> $GITHUB_ENV
+          echo "HUGGINGFACE_ACCESS_TOKEN=${{ secrets.HUGGINGFACE_ACCESS_TOKEN }}" >> $GITHUB_ENV
+
+          # Determine version based on trigger type
+          if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
+            # Manual trigger: use input version
+            VERSION="${{ github.event.inputs.version }}"
+            echo "RELEASE_VERSION=${VERSION}" >> $GITHUB_ENV
+            echo "IS_MANUAL_RELEASE=true" >> $GITHUB_ENV
+          else
+            # Tag trigger: use tag name (remove refs/tags/ prefix)
+            VERSION=${GITHUB_REF#refs/tags/}
+            echo "RELEASE_VERSION=${VERSION}" >> $GITHUB_ENV
+            echo "IS_MANUAL_RELEASE=false" >> $GITHUB_ENV
+          fi
+
+      - name: Build and push the images to Docker Hub
+        uses: docker/bake-action@v2
+        with:
+          push: true
+          set: |
+            *.args.DOCKERHUB_REPO=${{ env.DOCKERHUB_REPO }}
+            *.args.DOCKERHUB_IMG=${{ env.DOCKERHUB_IMG }}
+            *.args.RELEASE_VERSION=${{ env.RELEASE_VERSION }}
+            *.args.HUGGINGFACE_ACCESS_TOKEN=${{ env.HUGGINGFACE_ACCESS_TOKEN }}
+
+      - name: Create GitHub Release
+        if: env.IS_MANUAL_RELEASE == 'false'
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref_name }}
+          release_name: Release ${{ github.ref_name }}
+          body: |
+            Release ${{ github.ref_name }}
+
+            Docker Image: `${{ env.DOCKERHUB_REPO }}/${{ env.DOCKERHUB_IMG }}:${{ env.RELEASE_VERSION }}`
+
+            ## Changes
+            See [commit history](https://github.com/${{ github.repository }}/commits/${{ github.ref_name }}) for detailed changes.
+          draft: false
+          prerelease: false
+
+      - name: Manual Release Summary
+        if: env.IS_MANUAL_RELEASE == 'true'
+        run: |
+          echo "🚀 Manual release completed!"
+          echo "Version: ${{ env.RELEASE_VERSION }}"
+          echo "Docker Image: ${{ env.DOCKERHUB_REPO }}/${{ env.DOCKERHUB_IMG }}:${{ env.RELEASE_VERSION }}"
+          echo "Note: No GitHub release created for manual triggers"