Skip to content
Distr
Star
Book DemoStart free trialLogin

GitHub Actions

distr-create-version-action

Section titled “distr-create-version-action”

Distr offers the distr-create-version-action GitHub Action that allows you to automatically create new versions of your application in Distr every time you push a new release. It supports both Docker and Helm applications.

Key Features

Section titled “Key Features”
  • Automatic Version Creation - Create new application versions in Distr on every release
  • Automatic Deployment Updates - Optionally update all customer deployments to the new version
  • Docker Support - Upload Docker Compose files with environment variable templates
  • Helm Support - Reference Helm charts from OCI or traditional repositories
  • Multi-Organization - Deploy to multiple Distr instances or organizations in parallel

Quick Example

Section titled “Quick Example”
name: Push Distr Application Version


on:
  push:
    tags:
      - '*'


jobs:
  push-to-distr:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4


      - uses: distr-sh/distr-create-version-action@v1
        with:
          api-token: ${{ secrets.DISTR_API_TOKEN }}
          application-id: ${{ vars.DISTR_APPLICATION_ID }}
          version-name: ${{ github.ref_name }}
          compose-file: ${{ github.workspace }}/docker-compose.yaml
          update-deployments: true

Attaching Additional Resources

Section titled “Attaching Additional Resources”

The action can attach additional resources (markdown documents such as release notes or upgrade instructions) to the created version via the resources input. It takes a JSON array where each resource has a name and either inline content or a path to a file on the runner. With visibleToCustomers (defaults to true) you control whether a resource is shown to your customers.

- uses: distr-sh/distr-create-version-action@v1
  with:
    api-token: ${{ secrets.DISTR_API_TOKEN }}
    application-id: ${{ vars.DISTR_APPLICATION_ID }}
    version-name: ${{ github.ref_name }}
    compose-file: ${{ github.workspace }}/docker-compose.yaml
    resources: |
      [
        { "name": "Release Notes", "path": "./docs/release-notes.md" },
        { "name": "Internal Notes", "content": "For support staff only.", "visibleToCustomers": false }
      ]

Complete Setup Guide

Section titled “Complete Setup Guide”

For a step-by-step guide covering:

  • Creating your application in Distr
  • Setting up Personal Access Tokens
  • Configuring GitHub secrets and variables
  • Setting up automatic deployment updates
  • Troubleshooting and advanced scenarios

See the Automatic Deployments from GitHub guide.

Additional Resources

Section titled “Additional Resources”