Skip to content

russdias/render-deploy

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

🚀 Render Deploy

GitHub Super-Linter CI License: MIT

A GitHub Action to automate deployments to Render.com services. This action allows you to trigger deployments and manage your Render services directly from your GitHub workflows.

Features

  • 🚀 Trigger deployments to Render.com services
  • 🔄 Automated deployment status tracking
  • 💬 GitHub deployment comments integration
  • 🔒 Secure API key handling
  • ⚡️ Fast Node.js runtime with minimal dependencies

Prerequisites

  1. A Render API key (get it from your Render Dashboard)
  2. Your Render service ID (found in the service URL or settings)

Inputs

Input Description Required
RENDER_API_KEY 🔑 Your Render API key Yes
RENDER_SERVICE_ID 🆔 The ID of the Render service to deploy Yes
WAIT_FOR_DEPLOYMENT 🔄 Wait for deployment to complete (bool) No

Outputs

Output Description
status 📊 The deployment status. Possible values:
- created
- build_in_progress
- update_in_progress
- live
- deactivated
- build_failed
- update_failed
- canceled
- pre_deploy_in_progress
- pre_deploy_failed

Example Workflow

name: Deploy to Render
on:
  push:
    branches:
      - main

permissions:
  contents: write
  pull_requests: write

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Deploy to Render
        uses: russdias/render-deploy@v1
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
        with:
          RENDER_API_KEY: ${{ secrets.RENDER_API_KEY }}
          RENDER_SERVICE_ID: ${{ secrets.RENDER_SERVICE_ID }}

Development

  1. Install dependencies:

    npm install
  2. Bundle the action:

    npm run all

License

MIT

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.