https://github.com/okteto/pipeline
Enable GitHub developers to trigger Okteto Pipelines from a GitHub Actions workflow
https://github.com/okteto/pipeline
cloud-computing github-actions kubernetes microservices okteto
Last synced: 5 months ago
JSON representation
Enable GitHub developers to trigger Okteto Pipelines from a GitHub Actions workflow
- Host: GitHub
- URL: https://github.com/okteto/pipeline
- Owner: okteto
- License: apache-2.0
- Created: 2020-09-02T20:00:20.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-05-07T09:58:35.000Z (5 months ago)
- Last Synced: 2025-05-11T02:18:03.999Z (5 months ago)
- Topics: cloud-computing, github-actions, kubernetes, microservices, okteto
- Language: Shell
- Homepage: https://okteto.com
- Size: 73.2 KB
- Stars: 16
- Watchers: 5
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: code-of-conduct.md
Awesome Lists containing this project
README
# 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](https://okteto.com).
Try Okteto for free for 30 days, no credit card required. [Start your 30-day trial now](https://www.okteto.com/free-trial/)!
# Github Action for developers to trigger Okteto Pipelines from a GitHub Actions workflow
You can use this action to trigger an [Okteto Pipeline](https://okteto.com/blog/cloud-based-development-environments/) based on Github events.
You can use this action to enable your CI/CD workflow in [Okteto](https://okteto.com).
[This document](https://okteto.com/docs/tutorials/getting-started-with-pipelines/index.html) has more information on this workflow.
The [Deploy Pipeline](https://github.com/okteto/pipeline) [GitHub action](https://github.com/okteto/actions) deploys your application based on the [Okteto Manifest](https://www.okteto.com/docs/reference/manifest/) present in your repository.
Your application will be deployed to the namespace that you specified.
## Inputs
### `name`
The name of the pipeline.
### `namespace`
The Okteto namespace to use. If not specified it will use the namespace specified by the `namespace` action.
### `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`.
### `skipIfExists`
Skip the pipeline deployment if the pipeline already exists in the namespace (defaults to false)
### `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.
### `filename`
The relative path within the repository to the pipeline file. If not specified the [default pipeline](https://okteto.com/docs/cloud/okteto-pipeline#customize-the-okteto-pipeline) is executed.
### `log-level`
Log level used. Supported values are: `debug`, `info`, `warn`, `error`. (defaults to warn)
# Example usage
This example runs the context action, activates a namespace, and triggers the Okteto pipeline
```yaml
# File: .github/workflows/workflow.yml
on:
pull_request:
branches:
- master
name: example
jobs:
devflow:
runs-on: ubuntu-latest
steps:
- name: checkout
uses: actions/checkout@master
- name: context
uses: okteto/context@latest
with:
url: https://okteto.example.com
token: ${{ secrets.OKTETO_TOKEN }}
- name: "Activate Namespace"
uses: okteto/namespace@latest
with:
name: cindylopez
- name: "Trigger the pipeline"
uses: okteto/pipeline@latest
with:
name: pr-${{ github.event.number }}
timeout: 8m
skipIfExists: true
variables: "DB_HOST=mysql,CONFIG_PATH=/tmp/config.yaml"
```
## 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](https://www.okteto.com/docs/self-hosted/) instance. We recommend that you store the certificate as an [encrypted secret](https://docs.github.com/en/actions/reference/encrypted-secrets), and that you define the environment variable for the entire job, instead of doing it on every step.
```yaml
# File: .github/workflows/workflow.yml
on: [push]
name: example
jobs:
devflow:
runs-on: ubuntu-latest
env:
OKTETO_CA_CERT: ${{ secrets.OKTETO_CA_CERT }}
steps:
- uses: okteto/context@latest
with:
url: https://okteto.example.com
token: ${{ secrets.OKTETO_TOKEN }}
- name: "Activate Namespace"
uses: okteto/namespace@latest
with:
name: cindylopez
- name: "Trigger the pipeline"
uses: okteto/pipeline@latest
with:
name: pr-${{ github.event.number }}
timeout: 8m
skipIfExists: true
filename: .okteto/custom-pipeline.yaml
variables: "DB_HOST=mysql,CONFIG_PATH=/tmp/config.yaml"
```