Deploy workers from GitHub

​

How GitHub integration works

​

Requirements

• A working handler function in a GitHub repository.
• A Dockerfile in your repository. See Creating a Dockerfile for details.
• A GitHub account.

​

Authorizing Runpod with GitHub

1. Open the settings page in the Runpod console.
2. Find the GitHub card under Connections and click Connect.
3. Sign in using the GitHub authorization flow. This will open your GitHub account settings page.
4. Choose which repositories Runpod can access:
   • All repositories: Access to all current and future repositories.
   • Only select repositories: Choose specific repositories.
5. Click Save.

​

Deploying from GitHub

1. Go to the Serverless section of the Runpod console
2. Click New Endpoint
3. Under Custom Source, select GitHub Repo, then click Next
4. Use the search bar or menu to select the repository containing your code. This menu is populated with all repos connected to your account (repos you’ve forked/created, or owned by your GitHub organizations).
5. Configure your deployment options:
   • Branch: Select which branch to deploy from.
   • Dockerfile: Specify the path to your Dockerfile (if not in root).
6. (Optional) Enter a custom name for your endpoint.
7. Configure your compute resources (GPU type, worker count, etc.).
8. Click Create Endpoint.

​

Monitoring build status

​

Managing multiple environments

• Production endpoint tracking the main branch.
• Staging endpoint tracking the dev branch.

1. Create a new branch for your staging endpoint.
2. Create an endpoint for your production branch.
3. On the Serverless page of the Runpod console, click the three dots to the top right of your production endpoint. Click Clone Endpoint.
4. Expand the Repository Configuration section and select your staging branch.
5. Click Create Endpoint.

​

Continuous integration with GitHub Actions

1. Create a workflow file at .github/workflows/test-and-deploy.yml:
   Copy

   name: Test and Deploy
   
   on:
   push:
      branches: [ main ]
   pull_request:
      branches: [ main ]
   
   jobs:
   test-and-deploy:
      runs-on: ubuntu-latest
      steps:
      - uses: actions/checkout@v3
      
      - name: Build and push Docker image
         uses: docker/build-push-action@v4
         with:
         context: .
         push: true
         tags: [DOCKER_USERNAME]/[WORKER_NAME]:${{ github.sha }}
         
      - name: Run Tests
         uses: runpod/runpod-test-runner@v1
         with:
         image-tag: [DOCKER_USERNAME]/[WORKER_NAME]:${{ github.sha }}
         runpod-api-key: ${{ secrets.RUNPOD_API_KEY }} # Add your API key to a GitHub secret
         test-filename: .github/tests.json
         request-timeout: 300
   

   To add your Runpod API key to a GitHub secret, see Using secrets in GitHub Actions.
2. Create test cases for your repository at .github/tests.json:
   Copy

   [
   {
      "input": {
         "prompt": "Test input 1"
      },
      "expected_output": {
         "status": "COMPLETED"
      }
   },
   {
      "input": {
         "prompt": "Test input 2",
         "parameter": "value"
      },
      "expected_output": {
         "status": "COMPLETED"
      }
   }
   ]
   

​

Limitations

​

GitHub integration limitations

• Build time limit: Builds must complete within 160 minutes (2.5 hours). Optimize your Dockerfile for efficiency with large images to avoid timeouts.
• Image size restriction: Docker images cannot exceed 80 GB. Plan your image requirements accordingly, particularly when including large model weights or dependencies.
• Base image limitations: The integration doesn’t support privately hosted images as base images. Consider incorporating essential components directly into your Dockerfile instead.
• Hardware-specific builds: Builds requiring GPU access during construction (such as those using GPU-compiled versions of libraries like bitsandbytes) are not supported.
• Platform exclusivity: Images built through Runpod’s image builder service are designed exclusively for Runpod’s infrastructure and cannot be pulled or executed on other platforms.
• Single GitHub connection: Each Runpod account can link to only one GitHub account. This connection cannot be shared among team members, requiring separate Runpod accounts for collaborative projects.

​

Disconnecting GitHub

1. Go to Runpod Settings → Connections → Edit Connection
2. Select your GitHub account.
3. Click Configure.
4. Scroll down to the Danger Zone.
5. Uninstall “Runpod Inc.”

​

Troubleshooting deployment issues

• Check the build logs in the Runpod console for error messages.
• Verify your Dockerfile is properly configured.
• Ensure your handler function works correctly in local testing.
• Check that your repository structure matches what’s expected in your Dockerfile.
• Verify you have the necessary permissions on the GitHub repository.

​

Next steps

• Send API requests to your endpoint.
• Create more advanced handler functions.
• Optimize your endpoint configurations.
• Learn how to deploy workers from Docker Hub.