Learn how to integrate Ocuroot with your existing CI/CD pipeline
Ocuroot is designed to work seamlessly with your existing CI/CD infrastructure. Rather than replacing your current CI setup, Ocuroot enhances it by providing build tracking, deployment management, and dependency resolution capabilities.
The core philosophy of Ocuroot’s CI integration is to augment rather than replace. You can continue using your preferred CI platform (GitHub Actions, Jenkins, CircleCI, etc.) to schedule and execute work, while taking advantage of Ocuroot’s configuration model along with its build and deployment management features.
Ocuroot integrates with your CI platform through three main commands: ocuroot review
, ocuroot deliver
, and ocuroot sync
.
ocuroot review
Run this command when a pull request is submitted. It acts as a helper for your code review process by:
ocuroot deliver
Execute this command when code is merged into your main branch. This step:
ocuroot sync
Trigger this command via a custom webhook to manage deployments. This command:
You can configure subsequent sync operations using the trigger_sync
function in your repo.ocu.star
file.
This allows you to create deployment chains where one deployment automatically triggers another when appropriate conditions are met.
For example:
For more details on trigger_sync
configuration, see the trigger_sync documentation.
To authenticate Ocuroot commands in your CI environment, you’ll need to set up the OCUROOT_API_KEY
environment variable.
This API key is not required for ocuroot review
but is necessary for the other two commands (ocuroot deliver
and ocuroot sync
).
You can obtain your API key from the Ocuroot web UI. Once you have it:
OCUROOT_API_KEY
as a secure environment variable in your CI platformFor detailed instructions on obtaining and managing API keys, refer to our authentication documentation.
While we provide a specific example for GitHub Actions, the principles outlined here can be applied to any CI platform. The key is to: