Skip to content

cdviz-dev/transformers-community

Repository files navigation

CDviz Community Transformers

Community driven transformers for cdviz-collector that convert various event sources into CDEvents.

Available Transformers

Transformer Source Description
github_events GitHub Webhooks Converts GitHub events (workflow runs, issues, PRs, releases) to CDEvents
argocd_notifications ArgoCD Webhooks Converts ArgoCD application lifecycle events to CDEvents
kubewatch_cloudevents Kubernetes Events Converts Kubewatch CloudEvents to CDEvents
passthrough CDEvents Passthrough transformer for existing CDEvents

Usage

Import Transformers Remotely

Add to your cdviz-collector.toml:

[remote.transformers-community]
type = "github"
owner = "cdviz-dev"
repo = "transformers-community"
# token = "gh...."  # Optional: github token

[transformers]
github_events = { type = "vrl", template_rfile = "transformers-community:///github_events/transformer.vrl" }
kubewatch_cloudevents = { type = "vrl", template_rfile = "transformers-community:///kubewatch_cloudevents/transformer.vrl" }
argocd_notifications = { type = "vrl", template_rfile = "transformers-community:///argocd_notifications/transformer.vrl" }

Use Transformers Locally

Clone the repository and reference transformers directly:

[transformers.github_events]
type = "vrl"
template_file = "./path/to/transformers-community/github_events/transformer.vrl"

Development

Testing

Each transformer includes sample inputs and expected outputs for testing:

# Test all transformers
mise run :test

# Test specific transformer
mise run //github_events:test

# Review and update expected outputs
mise run //github_events:test -- --mode review

Code Style

# Format code
mise run :format

See AGENTS.md for detailed guidelines on code style and conventions.

Contributing

Contributions are welcome! Each transformer should include:

  • transformer.vrl - VRL transformation logic
  • cdviz-collector.toml - Configuration example
  • inputs/ - Sample input events
  • outputs/ - Expected output CDEvents
  • README.md - Documentation with usage examples
  • mise.toml - Task to test/review the transformer against its inputs.

License

Apache-2.0

About

A repository to host transformers for cdviz-collector

Resources

License

Contributing

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •