windmill/docs/enterprise.md

Enterprise (EE) Development

File Conventions

• Enterprise files use the *_ee.rs suffix
• Source lives in windmill-ee-private (sibling repo), symlinked into each crate's src/
• _ee.rs files are gitignored in the main windmill repo — tracked only in windmill-ee-private
• Use feature flags: #[cfg(feature = "enterprise")] for enterprise logic
• The private feature flag gates compilation of *_ee.rs files
• The license feature flag gates features that require a valid license key at runtime
• Isolate enterprise code in separate modules

Finding the EE Repo

• Standard location: ~/windmill-ee-private
• Worktree location: ~/windmill-ee-private__worktrees/<branch-name>/

EE PR Workflow (MUST DO when modifying *_ee.rs files)

When you modify any *_ee.rs file and create a PR on windmill:

1. Create a matching branch in windmill-ee-private (same branch name)
2. Commit and push the _ee.rs changes in that branch
3. Create a PR on windmill-ee-private with a link to the companion windmill PR
4. Update ee-repo-ref.txt: Run bash write_latest_ee_ref.sh from backend/
   • Verify it wrote the correct commit hash from your branch, not from main (the script may fall back to ~/windmill-ee-private on main)
   • If wrong, manually write the correct hash
5. Commit ee-repo-ref.txt in the windmill repo so CI picks up the correct EE ref

Validation

# EE code (always include private to compile *_ee.rs files)
cargo check --features enterprise,private

# EE code that also requires license validation
cargo check --features enterprise,private,license