Integrations & Advanced Usage
Github Actions
This page explains how to set up AskUI with GitHub Actions, including dependency setup, environment variables, test execution, and optional report generation.
GitHub Actions
Automate your AskUI workflows with GitHub Actions in just a few simple steps!
1. Project Setup
Place your AskUI Python scripts in a directory at the root of your repository (e.g., tests
or automation
).
Note: The directory structure may vary based on your project organization.
2. Pipeline Configuration
1
Configure Python Environment
Set up Python 3.10 or higher in your workflow
2
Install Dependencies
3
Configure Environment Variables
Add the following required variables:
ASKUI_WORKSPACE_ID
ASKUI_TOKEN
Optional:
ANTHROPIC_API_KEY
- Required if using Anthropic models
4
Run Tests
5
Optional Steps
- Set up AskUI Agent OS as a service
- Generate test reports with pytest-html
- Deploy or distribute reports
Example Implementation
Here’s a sample GitHub Actions workflow file (.github/workflows/askui-automation.yml
):