Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
anchor

GitHub Action

Kamal Deploy

v0.1.3

Kamal Deploy

anchor

Kamal Deploy

GitHub Action to build and deploy Docker image with Kamal

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Kamal Deploy

              
  uses: igor-alexandrov/[email protected]
Learn more about this action in igor-alexandrov/kamal-deploy

Choose a version

Kamal Deploy Action

This GitHub Action deploys using Kamal. Supports Kamal v2.0 and later.

Inputs

To update the README to reflect the optional environment input, you can modify the usage section to indicate that environment is no longer required and explain how the action behaves when environment is omitted.

Here's how the README might look:

Kamal Deploy GitHub Action

This GitHub Action deploys your application using Kamal and handles cancellation gracefully.

Inputs

Name Description Required Default
environment Optional deployment environment (e.g., production, staging). If omitted, the --destination flag is not passed. No None
registry-username Registry Username (e.g., Digital Ocean Access Token) Yes
registry-password Registry Password (e.g., Digital Ocean Access Token) Yes

Note: Only registry-username and registry-password are required. Any other necessary configuration, such as DATABASE_URL, REDIS_URL, and RAILS_MASTER_KEY, should be provided as environment variables in the workflow file.

Usage

steps:
  - name: Kamal Deploy
    uses: igor-alexandrov/[email protected]
    with:
      # environment: 'staging'  # Optional, only used if provided
      registry-username: ${{ secrets.KAMAL_REGISTRY_USERNAME }}
      registry-password: ${{ secrets.KAMAL_REGISTRY_PASSWORD }}
    env:
      DATABASE_URL: ${{ secrets.DATABASE_URL }}
      REDIS_URL: ${{ secrets.REDIS_URL }}
      RAILS_MASTER_KEY: ${{ secrets.RAILS_MASTER_KEY }}