GitHub Actions for Okteto

Automate your development workflows using Github Actions and Okteto

GitHub Actions gives you the flexibility to build automated software development workflows. With GitHub Actions for Okteto you can create workflows to build, deploy and update your applications in Okteto. Follow this tutorial for a full preview environment configuration sample.

Try Okteto for free for 30 days, no credit card required. Start your 30-day trial now!

Github Action for running tests in Okteto

You can use this action to run tests in Okteto as part of your automated CI and development workflow.

Inputs

name

The name of the Okteto dev environment to create.

namespace

If present, the namespace scope for this action. If not specified, it will use the current context

file

Relative path within the repository to the manifest file (default to okteto-pipeline.yaml or .okteto/okteto-pipeline.yaml).

deploy

Deploy the dev environment always even if it has already been deployed

no-cache

Do not use cache for runnings the tests

variables

A list of variables to be used by the pipeline. If several variables are present, they should be separated by commas e.g. VAR1=VAL1,VAR2=VAL2,VAR3=VAL3.

timeout

The length of time to wait for completion. Values should contain a corresponding time unit e.g. 1s, 2m, 3h. If not specified it will use 5m.

tests

The test sections to run, separated by spaces. If no tests are specified all tests are run.

log-level

Log level used. Supported values are: debug, info, warn, error. (defaults to warn)

Example usage

This example runs the context action and then runs the tests deploying the dev environment if it hasn't been deployed yet

# File: .github/workflows/workflow.yml
on: [push]

name: example

jobs:

  devflow:
    runs-on: ubuntu-latest
    steps:
    - name: Context
      uses: okteto/context@latest
      with:
        url: https://okteto.example.com
        token: ${{ secrets.OKTETO_TOKEN }}

    - name: "Run tests"
      uses: okteto/test@latest
      with:
        tests: "integration"
        variables: "USER=admin,PASS=admin"

Advanced usage

Custom Certification Authorities or Self-signed certificates

You can specify a custom certificate authority or a self-signed certificate by setting the OKTETO_CA_CERT environment variable. When this variable is set, the action will install the certificate in the container, and then execute the action.

Use this option if you're using a private Certificate Authority or a self-signed certificate in your Okteto SH instance. We recommend that you store the certificate as an encrypted secret, and that you define the environment variable for the entire job, instead of doing it on every step.

# File: .github/workflows/workflow.yml
on: [push]

name: example

jobs:
  devflow:
    runs-on: ubuntu-latest
    env:
      OKTETO_CA_CERT: ${{ secrets.OKTETO_CA_CERT }}

    steps:
     - name: Checkout code
       uses: actions/checkout@v4
         with:
           # ... see https://github.com/actions/checkout?tab=readme-ov-file#usage

     - name: Set Okteto context
       uses: okteto/context@latest
       with:
         url: https://okteto.example.com
         token: ${{ secrets.OKTETO_TOKEN }}

     - name: Run tests
       uses: okteto/test@latest
       with:
         tests: integration
         variables: "USER=admin,PASS=admin"