How windmill-labs/windmill-sync-example works
This repository is a Windmill-to-GitHub deployment example, not an application runtime. Its principal workflow is: a user deploys a Windmill asset to staging, Windmill commits it on a per-asset branch, GitHub Actions opens a pull request for review, and a merge triggers deployment to production. The tree contains representative Windmill assets under f/; the README documents the sync and deployment behavior. The action files are included because they implement that workflow. Asset-to-asset runtime behavior is not established by the sampled scripts.
Main entry points: push-on-merge.yaml Push on merge action · open-pr-on-commit.yaml Open PR action · f Scripts, flows, apps
Components 9
Staging Sync
- Staging workspace
- GitHub repository
Review
- GitHub
- Open PR action
.github/workflows/open-pr-on-commit.yaml - Approved reviewers
Production Release
- Push on merge action
.github/workflows/push-on-merge.yaml - Production workspace
Windmill Assets
Other components
- Windmill user
Connections 9
- Windmill user → Staging workspace: deploys asset
- Staging workspace → GitHub repository: commits branch
- GitHub repository → Scripts, flows, apps: stores assets
- GitHub → Open PR action: triggers on branch
- Open PR action → GitHub: creates pull request
- Approved reviewers → GitHub: review and merge
- GitHub → Push on merge action: triggers on merge
- Push on merge action → GitHub repository: reads content
- Push on merge action → Production workspace: deploys content