This directory contains the GitHub Actions workflows for the CodeFlow monorepo.
The monorepo uses a combination of engine-specific workflows, path-aware component workflows, and release workflows.
| Workflow | Purpose | Triggers |
|---|---|---|
ci.yml |
Engine test and build validation | Push, PR, manual |
lint.yml |
Engine lint and type checks | Push, PR |
security.yml |
Engine dependency and filesystem security checks | Push, PR, schedule |
monorepo-ci.yml |
Path-aware builds for engine, desktop, website, orchestration utils, and VS Code extension | Push, PR, manual |
release.yml |
Engine package release | Tags, manual |
release-desktop.yml |
Desktop release build | Tags, manual |
release-website.yml |
Website release build | Tags, manual |
release-vscode-extension.yml |
VS Code extension release packaging | Tags, manual |
release-orchestration-utils.yml |
Shared utility package release build | Tags, manual |
deploy-autopr-engine.yml |
Engine container build and Azure deployment | Push to master, PR, manual |
- Engine workflows run from engine via
working-directory. - Component workflows use path filters so unrelated changes do not trigger full builds.
- Release workflows use component-specific tag prefixes such as
engine-v0.2.0-alpha.1anddesktop-v0.2.0-alpha.1. - Infrastructure for the website and engine is sourced from orchestration.
- The engine deployment workflow still uses the filename deploy-autopr-engine.yml for backward compatibility, but it deploys the current CodeFlow Engine.
Before archiving the legacy repositories, update their README files with the redirect snippets from docs/LEGACY_REPO_REDIRECTS.md.
-
PR Created/Updated:
PR-Checksruns immediately (fast validation)Quality Feedbackruns (detailed feedback)CIruns (comprehensive checks)
-
Push to master:
CIruns with full volume settings
-
Manual/Scheduled:
BG-Fixruns for maintenance
All workflows respect the CODEFLOW volume system:
# Repository variables (set in GitHub settings)
CODEFLOW_VOLUME_PR=100 # PR volume
CODEFLOW_VOLUME_CHECKIN=50 # Push volume
CODEFLOW_VOLUME_DEV=200 # Development volumeAdd these badges to your README:


Workflow not running:
- Check branch protection rules
- Verify workflow file syntax
- Check repository permissions
Volume-based execution issues:
- Verify repository variables are set
- Check volume calculation logic
- Review conditional job logic
Pre-commit failures:
- Run
pre-commit installlocally - Check
.pre-commit-config.yamlsyntax - Verify hook dependencies
Codecov warnings ("Please install the 'codecov app svg image'"):
- Install the Codecov GitHub App
- Grant access to your repository in the app settings
- Ensure
CODECOV_TOKENsecret is set in repository settings - See
codecov.ymlin the repository root for configuration
Enable debug logging:
env:
ACTIONS_STEP_DEBUG: true
ACTIONS_RUNNER_DEBUG: trueCheck workflow runs:
- Go to Actions tab in GitHub
- Select specific workflow
- Review logs for errors
- Define purpose: What unique value does this workflow provide?
- Check overlap: Ensure no redundancy with existing workflows
- Add documentation: Update this README
- Test thoroughly: Verify triggers and conditions
- Update documentation: Reflect changes in this README
- Test changes: Use workflow dispatch for testing
- Consider impact: How do changes affect other workflows?
- Keep workflows focused: Each workflow should have a single, clear purpose
- Use volume awareness: Leverage the volume system for conditional execution
- Provide feedback: Always give clear feedback to contributors
- Handle failures gracefully: Use
continue-on-errorandif: always()appropriately - Optimize for speed: Minimize redundant work and optimize execution time
Set these in GitHub repository settings:
| Variable | Description | Default |
|---|---|---|
CODEFLOW_VOLUME_PR |
Volume for pull requests | 100 |
CODEFLOW_VOLUME_CHECKIN |
Volume for pushes | 50 |
CODEFLOW_VOLUME_DEV |
Volume for development | 200 |
| Variable | Description | Default |
|---|---|---|
PYTHON_VERSION |
Python version to use | 3.13 |
CODEFLOW_PRECOMMIT_VOLUME |
Pre-commit volume | 100 |
CODEFLOW_BG_BATCH |
Background fix batch size | 30 |
For workflow issues:
- Check this documentation
- Review workflow logs
- Create an issue with workflow name and error details
- Tag with
workflowlabel