11_registry_tasks.rst

Registry tasks

Breeze commands for building the Apache Airflow Provider Registry.

These are all of the available registry commands:

Extracting registry data

The breeze registry extract-data command runs the three extraction scripts (extract_metadata.py, extract_parameters.py, extract_connections.py) inside a breeze CI container where all providers are installed. This is the same command used by the registry-build.yml CI workflow.

Example usage:

# Extract all registry data with default Python version
breeze registry extract-data

# Extract with a specific Python version
breeze registry extract-data --python 3.12

Publishing version metadata

The breeze registry publish-versions command lists S3 directories under providers/{id}/ to discover every deployed version, then writes api/providers/{id}/versions.json for each provider. It also invalidates the CloudFront cache for the staging or live distribution.

This is the same command used by the registry-build.yml CI workflow after syncing the built site to S3.

Example usage:

# Publish to staging
breeze registry publish-versions --s3-bucket s3://staging-docs-airflow-apache-org/registry/

# Publish to live
breeze registry publish-versions --s3-bucket s3://live-docs-airflow-apache-org/registry/

# With a custom providers.json
breeze registry publish-versions --s3-bucket s3://bucket/registry/ --providers-json path/to/providers.json

---

Next step: Follow the Issue tasks instructions to learn more about issue tasks.