kodexa-ai/Kodexa Sync
GitOps deployment for Kodexa metadata - branch mappings drive everything
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| sync-config | Path to sync-config.yaml (auto-discovered if not specified) | no | "" |
| metadata-dir | Metadata directory override (auto-discovered if not specified) | no | "" |
| dry-run | Preview deployment without making changes (true/false) | no | false |
| kdx-version | kdx-cli version to use (default: latest) | no | latest |
| threads | Number of parallel threads for resource deployment (default: 8) | no | 8 |
| filter | Filter pattern for resources (e.g., "invoice-*") | no | "" |
| branch | Override branch detection with specific branch mapping | no | "" |
| tag | Override branch detection with specific tag mapping | no | "" |
| slack-channel-id | Slack channel ID to post deployment summary (optional) | no | "" |
| slack-token | Slack Bot Token for posting messages (optional) | no | "" |
| use-prerelease | Use prerelease (develop) version of kdx-cli (true/false) | no | false |
| annotate-summary | Add deployment summary to GitHub Actions job summary (true/false) | no | false |
| mode | Action mode: "deploy" (push to platform) or "pull" (pull from platform to git) | no | deploy |
| target | Target name from sync-config.yaml (required for pull mode) | no | "" |
| environment | Environment name from sync-config.yaml (required for pull mode) | no | "" |
| discover | Enable --discover to find and merge new resources (pull mode only) | no | true |
| skip-missing | Skip resources not found on server instead of failing (pull mode only) | no | false |
| branch-name | Branch name for pull mode commits (default: sync/<environment>) | no | "" |
| pr-title | PR title for pull mode (default: "Sync from <environment>") | no | "" |
| pr-base | Base branch for the PR (default: main) | no | main |
Outputs
| name | description |
|---|---|
| targets-deployed | Number of targets deployed |
| resources-created | Number of resources created |
| resources-updated | Number of resources updated |
| resources-skipped | Number of resources skipped (unchanged) |
| json-report-path | Path to the JSON report file |
| pr-url | URL of the created or updated pull request (pull mode only) |
| changes-detected | Whether any file changes were detected after pull |