Registry tasks

.. Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

.. http://www.apache.org/licenses/LICENSE-2.0

.. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Registry tasks

Breeze commands for building the Apache Airflow Provider Registry.

These are all of the available registry commands:

.. image:: ./images/output_registry.svg :target: https://raw.githubusercontent.com/apache/airflow/main/dev/breeze/doc/images/output_registry.svg :width: 100% :alt: Breeze 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.

.. image:: ./images/output_registry_extract-data.svg :target: https://raw.githubusercontent.com/apache/airflow/main/dev/breeze/doc/images/output_registry_extract-data.svg :width: 100% :alt: Breeze registry extract-data

Example usage:

.. code-block:: bash

 # 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

Backfilling older versions ..........................

The breeze registry backfill command extracts runtime parameters and connection types for older provider versions without Docker. It uses uv run --with to install the specific provider version in a temporary environment and runs extract_parameters.py and extract_connections.py.

This is useful when you need to add pages for previously released versions that were not included in the initial registry build.

.. image:: ./images/output_registry_backfill.svg :target: https://raw.githubusercontent.com/apache/airflow/main/dev/breeze/doc/images/output_registry_backfill.svg :width: 100% :alt: Breeze registry backfill

Example usage:

.. code-block:: bash

 # Backfill a single version
 breeze registry backfill --provider amazon --version 9.15.0

 # Backfill multiple versions at once
 breeze registry backfill --provider amazon --version 9.15.0 --version 9.14.0 --version 9.13.0

 # Backfill a hyphenated provider
 breeze registry backfill --provider microsoft-azure --version 11.0.0

Each run uses an isolated temporary providers.json, so different providers can be backfilled in parallel from separate terminal sessions:

.. code-block:: bash

 # Terminal 1
 breeze registry backfill --provider amazon --version 9.15.0 --version 9.14.0

 # Terminal 2 (safe to run simultaneously)
 breeze registry backfill --provider google --version 14.0.0 --version 13.0.0

Output is written to registry/src/_data/versions/{provider}/{version}/:

• parameters.json — operator/sensor/hook parameters
• connections.json — connection type definitions

After backfilling, you still need to:

1. Extract metadata from git tags: uv run python dev/registry/extract_versions.py --provider {id} --version {version}
2. Build the Eleventy site: cd registry && pnpm build
3. Sync new version pages to S3
4. Run breeze registry publish-versions to update version dropdowns

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.

.. image:: ./images/output_registry_publish-versions.svg :target: https://raw.githubusercontent.com/apache/airflow/main/dev/breeze/doc/images/output_registry_publish-versions.svg :width: 100% :alt: Breeze registry publish-versions

Example usage:

.. code-block:: bash

 # 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 <12_issue_tasks.rst>__ instructions to learn more about issue tasks.