GitHub-based deployments

This guide will walk you through setting up automated deployments for your applications using GitHub Actions and Valyent. By the end, you’ll have a fully automated CI/CD pipeline that builds, pushes, and deploys your application whenever you push code to your repository.

Before You Begin

Let’s make sure you have everything needed to get started:

Create Your Valyent Account

Create Your Application

Set up your application in the Valyent Console. This is where your deployments will live.

Setting Up GitHub Secrets

Let’s configure the secrets your workflow will need:

Navigate to Repository Settings

Open your GitHub repository
Click “Settings” in the top navigation
Select “Secrets and variables” from the sidebar
Choose “Actions”

Add Required Secrets

Create the following secrets by clicking “New repository secret” for each one:

Secret Name	Value to Add	How to Get It
`VALYENT_API_KEY`	Your API key	1. Open Valyent Console 2. Navigate to “API Keys” 3. Create a new key and copy it
`VALYENT_ORG`	Organization slug	Find this in your Valyent Console settings
`VALYENT_APP`	Application name	Check your applications page or run `valyent fleets list`

Your repository settings should look like this now.

Creating Your Workflow

Now, let’s set up the GitHub Actions workflow that will handle your deployments:

Create Workflow File

Create a new file at .github/workflows/build-and-deploy.yml in your repository.

Add Workflow Configuration

Copy the following workflow configuration into your new file:

Complete Workflow Configuration

name: Build and Deploy to Valyent

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Login to Valyent Registry
        uses: docker/login-action@v3
        with:
          registry: registry.valyent.cloud
          username: ${{ github.actor }}
          password: ${{ secrets.VALYENT_API_KEY }}

      - name: Extract metadata for Docker
        id: metadata
        uses: docker/metadata-action@v5
        with:
          images: registry.valyent.cloud/${{ secrets.VALYENT_ORG }}/${{ secrets.VALYENT_APP }}

      - name: Build and push Docker image
        uses: docker/build-push-action@v5
        with:
          context: .
          push: true
          tags: ${{ steps.metadata.outputs.tags }}
          labels: ${{ steps.metadata.outputs.labels }}

      - name: Install Valyent CLI
        run: |
          curl -L https://cli.valyent.cloud | sh

      - name: Authenticate Valyent CLI
        env:
          VALYENT_API_KEY: ${{ secrets.VALYENT_API_KEY }}
        run: |
          ~/.valyent/bin/valyent auth login \
            --api-key $VALYENT_API_KEY \
            --organization ${{ secrets.VALYENT_ORG }}

      - name: Deploy to Valyent
        run: |
          ~/.valyent/bin/valyent deploy --no-build \
            --organization ${{ secrets.VALYENT_ORG }} \
            --fleet ${{ secrets.VALYENT_APP }}

Understanding the Workflow

Here’s what each step in your workflow does:

Code Checkout: Grabs your latest code
Registry Login: Connects to Valyent’s Docker registry
Metadata Setup: Prepares Docker image information
Build & Push: Creates and uploads your Docker image
CLI Setup: Installs Valyent’s command-line tool
Authentication: Logs in to Valyent
Deployment: Launches your application

Testing Your Deployment

Let’s verify everything works:

Trigger a Deployment

Make a small change to your repository
Commit and push to your default branch
Open your repository’s “Actions” tab

Monitor Progress

Watch the workflow run and check each step’s output for any issues.

Verify Deployment

Once complete, check your Valyent Console to see your deployed application.

Troubleshooting Guide

If you run into problems, here’s how to fix common issues:

Common Issues and Solutions

Next Steps

Now that your automated deployment is set up, consider:

Adding environment-specific configurations
Setting up branch-based deployments
Implementing deployment notifications
Adding test stages to your workflow

Additional Resources

On this page

Before You Begin
Setting Up GitHub Secrets
Creating Your Workflow
Testing Your Deployment
Troubleshooting Guide
Next Steps
Additional Resources

Before You Begin

Let’s make sure you have everything needed to get started:

Create Your Valyent Account

Create Your Application

Set up your application in the Valyent Console. This is where your deployments will live.

Setting Up GitHub Secrets

Let’s configure the secrets your workflow will need:

Navigate to Repository Settings

Open your GitHub repository
Click “Settings” in the top navigation
Select “Secrets and variables” from the sidebar
Choose “Actions”

Add Required Secrets

Create the following secrets by clicking “New repository secret” for each one:

Secret Name	Value to Add	How to Get It
`VALYENT_API_KEY`	Your API key	1. Open Valyent Console 2. Navigate to “API Keys” 3. Create a new key and copy it
`VALYENT_ORG`	Organization slug	Find this in your Valyent Console settings
`VALYENT_APP`	Application name	Check your applications page or run `valyent fleets list`

Your repository settings should look like this now.

Creating Your Workflow

Now, let’s set up the GitHub Actions workflow that will handle your deployments:

Create Workflow File

Create a new file at .github/workflows/build-and-deploy.yml in your repository.

Add Workflow Configuration

Copy the following workflow configuration into your new file:

Complete Workflow Configuration

name: Build and Deploy to Valyent

on:
  push:
    branches:
      - main
  pull_request:
    branches:
      - main

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest

    steps:
      - name: Checkout repository
        uses: actions/checkout@v4

      - name: Login to Valyent Registry
        uses: docker/login-action@v3
        with:
          registry: registry.valyent.cloud
          username: ${{ github.actor }}
          password: ${{ secrets.VALYENT_API_KEY }}

      - name: Extract metadata for Docker
        id: metadata
        uses: docker/metadata-action@v5
        with:
          images: registry.valyent.cloud/${{ secrets.VALYENT_ORG }}/${{ secrets.VALYENT_APP }}

      - name: Build and push Docker image
        uses: docker/build-push-action@v5
        with:
          context: .
          push: true
          tags: ${{ steps.metadata.outputs.tags }}
          labels: ${{ steps.metadata.outputs.labels }}

      - name: Install Valyent CLI
        run: |
          curl -L https://cli.valyent.cloud | sh

      - name: Authenticate Valyent CLI
        env:
          VALYENT_API_KEY: ${{ secrets.VALYENT_API_KEY }}
        run: |
          ~/.valyent/bin/valyent auth login \
            --api-key $VALYENT_API_KEY \
            --organization ${{ secrets.VALYENT_ORG }}

      - name: Deploy to Valyent
        run: |
          ~/.valyent/bin/valyent deploy --no-build \
            --organization ${{ secrets.VALYENT_ORG }} \
            --fleet ${{ secrets.VALYENT_APP }}

Understanding the Workflow

Here’s what each step in your workflow does:

Code Checkout: Grabs your latest code
Registry Login: Connects to Valyent’s Docker registry
Metadata Setup: Prepares Docker image information
Build & Push: Creates and uploads your Docker image
CLI Setup: Installs Valyent’s command-line tool
Authentication: Logs in to Valyent
Deployment: Launches your application

Testing Your Deployment

Let’s verify everything works:

Trigger a Deployment

Make a small change to your repository
Commit and push to your default branch
Open your repository’s “Actions” tab

Monitor Progress

Watch the workflow run and check each step’s output for any issues.

Verify Deployment

Once complete, check your Valyent Console to see your deployed application.

Troubleshooting Guide

If you run into problems, here’s how to fix common issues:

Common Issues and Solutions

Next Steps

Now that your automated deployment is set up, consider:

Adding environment-specific configurations
Setting up branch-based deployments
Implementing deployment notifications
Adding test stages to your workflow

Additional Resources

On this page

Before You Begin
Setting Up GitHub Secrets
Creating Your Workflow
Testing Your Deployment
Troubleshooting Guide
Next Steps
Additional Resources

Before You Begin

Setting Up GitHub Secrets

Creating Your Workflow

Testing Your Deployment

Troubleshooting Guide

Next Steps

Additional Resources

API Documentation

Fleets

Machines

Nodes

GitHub-based deployments

Before You Begin

Setting Up GitHub Secrets

Creating Your Workflow

Testing Your Deployment

Troubleshooting Guide

Next Steps

Additional Resources

​Before You Begin

​Setting Up GitHub Secrets

​Creating Your Workflow

​Testing Your Deployment

​Troubleshooting Guide

​Next Steps

​Additional Resources

API Documentation

Fleets

Machines

Nodes

​Before You Begin

​Setting Up GitHub Secrets

​Creating Your Workflow

​Testing Your Deployment

​Troubleshooting Guide

​Next Steps

​Additional Resources

Before You Begin

Setting Up GitHub Secrets

Creating Your Workflow

Testing Your Deployment

Troubleshooting Guide

Next Steps

Additional Resources

Before You Begin

Setting Up GitHub Secrets

Creating Your Workflow

Testing Your Deployment

Troubleshooting Guide

Next Steps

Additional Resources