@@ -455,7 +455,7 @@ Often errors during documentation generation come from the docstrings of auto-ap
455
455
During the docs building auto-api generated files are stored in the ``docs/_api `` folder. This helps you
456
456
easily identify the location the problems with documentation originated from.
457
457
458
- Those are all available flags of ``build-docs `` command:
458
+ These are all available flags of ``build-docs `` command:
459
459
460
460
.. image :: ./images/breeze/output_build-docs.svg
461
461
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_build-docs.svg
@@ -537,7 +537,7 @@ The above will run the check for the last 4 commits in your branch. You can use
537
537
in ``--from-ref `` and ``--to-ref `` flags.
538
538
539
539
540
- Those are all available flags of ``static-checks `` command:
540
+ These are all available flags of ``static-checks `` command:
541
541
542
542
.. image :: ./images/breeze/output_static-checks.svg
543
543
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_static-checks.svg
@@ -580,7 +580,7 @@ You can also use it to start any released version of Airflow from ``PyPI`` with
580
580
581
581
breeze start-airflow --python 3.8 --backend mysql --use-airflow-version 2.2.5
582
582
583
- Those are all available flags of ``start-airflow `` command:
583
+ These are all available flags of ``start-airflow `` command:
584
584
585
585
.. image :: ./images/breeze/output_start-airflow.svg
586
586
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_start-airflow.svg
@@ -605,7 +605,7 @@ to enter the running container. It's as easy as launching ``breeze exec`` while
605
605
Breeze environment. You will be dropped into bash and environment variables will be read in the same
606
606
way as when you enter the environment. You can do it multiple times and open as many terminals as you need.
607
607
608
- Those are all available flags of ``exec `` command:
608
+ These are all available flags of ``exec `` command:
609
609
610
610
.. image :: ./images/breeze/output_exec.svg
611
611
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_exec.svg
@@ -643,7 +643,7 @@ need to build the images again from scratch - pulling from the registry might ta
643
643
644
644
Breeze will ask you to confirm each step, unless you specify ``--answer yes `` flag.
645
645
646
- Those are all available flags of ``cleanup `` command:
646
+ These are all available flags of ``cleanup `` command:
647
647
648
648
.. image :: ./images/breeze/output_cleanup.svg
649
649
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_cleanup.svg
@@ -736,7 +736,7 @@ You can always stop it via:
736
736
737
737
breeze down
738
738
739
- Those are all available flags of ``down `` command:
739
+ These are all available flags of ``down `` command:
740
740
741
741
.. image :: ./images/breeze/output_down.svg
742
742
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_down.svg
@@ -1394,7 +1394,7 @@ download the latest images before rebuilding because this is usually faster than
1394
1394
Building CI image
1395
1395
.................
1396
1396
1397
- Those are all available flags of ` ` ci-image build` ` command:
1397
+ These are all available flags of ` ` ci-image build` ` command:
1398
1398
1399
1399
.. image:: ./images/breeze/output_ci-image_build.svg
1400
1400
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_ci-image_build.svg
@@ -1406,7 +1406,7 @@ Pulling CI image
1406
1406
1407
1407
You can also pull the CI images locally in parallel with optional verification.
1408
1408
1409
- Those are all available flags of ` ` pull` ` command:
1409
+ These are all available flags of ` ` pull` ` command:
1410
1410
1411
1411
.. image:: ./images/breeze/output_ci-image_pull.svg
1412
1412
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_ci-image_pull.svg
@@ -1419,7 +1419,7 @@ Verifying CI image
1419
1419
Finally, you can verify CI image by running tests - either with the pulled/built images or
1420
1420
with an arbitrary image.
1421
1421
1422
- Those are all available flags of ` ` verify` ` command:
1422
+ These are all available flags of ` ` verify` ` command:
1423
1423
1424
1424
.. image:: ./images/breeze/output_ci-image_verify.svg
1425
1425
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_ci-image_verify.svg
@@ -1488,7 +1488,7 @@ Same as above but uses python 3.8.
1488
1488
Building PROD image
1489
1489
...................
1490
1490
1491
- Those are all available flags of ``build-prod-image`` command:
1491
+ These are all available flags of ``build-prod-image`` command:
1492
1492
1493
1493
.. image:: ./images/breeze/output_prod-image_build.svg
1494
1494
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_prod-image_build.svg
@@ -1500,7 +1500,7 @@ Pulling PROD image
1500
1500
1501
1501
You can also pull PROD images in parallel with optional verification.
1502
1502
1503
- Those are all available flags of ``pull-prod-image`` command:
1503
+ These are all available flags of ``pull-prod-image`` command:
1504
1504
1505
1505
.. image:: ./images/breeze/output_prod-image_pull.svg
1506
1506
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_prod-image_pull.svg
@@ -1513,7 +1513,7 @@ Verifying PROD image
1513
1513
Finally, you can verify PROD image by running tests - either with the pulled/built images or
1514
1514
with an arbitrary image.
1515
1515
1516
- Those are all available flags of ``verify-prod-image`` command:
1516
+ These are all available flags of ``verify-prod-image`` command:
1517
1517
1518
1518
.. image:: ./images/breeze/output_prod-image_verify.svg
1519
1519
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_prod-image_verify.svg
@@ -1528,7 +1528,7 @@ Breeze has tools that you can use to configure defaults and breeze behaviours an
1528
1528
operations that might be necessary when you add new commands in Breeze. It also allows to configure your
1529
1529
host operating system for Breeze autocompletion.
1530
1530
1531
- Those are all available flags of ``setup`` command:
1531
+ These are all available flags of ``setup`` command:
1532
1532
1533
1533
.. image:: ./images/breeze/output_setup.svg
1534
1534
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_setup.svg
@@ -1552,7 +1552,7 @@ it off by passing ``--no-colour`` to config in which case the messages to the us
1552
1552
will be printed using different schemes (italic/bold/underline) to indicate different kind of messages
1553
1553
rather than colours.
1554
1554
1555
- Those are all available flags of ``setup config`` command:
1555
+ These are all available flags of ``setup config`` command:
1556
1556
1557
1557
.. image:: ./images/breeze/output_setup_config.svg
1558
1558
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_setup_config.svg
@@ -1570,7 +1570,7 @@ also force reinstalling the autocomplete via:
1570
1570
1571
1571
breeze setup autocomplete --force
1572
1572
1573
- Those are all available flags of ``setup-autocomplete`` command:
1573
+ These are all available flags of ``setup-autocomplete`` command:
1574
1574
1575
1575
.. image:: ./images/breeze/output_setup_autocomplete.svg
1576
1576
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_setup_autocomplete.svg
@@ -1583,7 +1583,7 @@ Breeze version
1583
1583
You can display Breeze version and with ``--verbose`` flag it can provide more information: where
1584
1584
Breeze is installed from and details about setup hashes.
1585
1585
1586
- Those are all available flags of ``version`` command:
1586
+ These are all available flags of ``version`` command:
1587
1587
1588
1588
.. image:: ./images/breeze/output_setup_version.svg
1589
1589
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_setup_version.svg
@@ -1594,7 +1594,7 @@ Those are all available flags of ``version`` command:
1594
1594
Breeze self-upgrade
1595
1595
...................
1596
1596
1597
- You can self-upgrade breeze automatically. Those are all available flags of ``self-upgrade`` command:
1597
+ You can self-upgrade breeze automatically. These are all available flags of ``self-upgrade`` command:
1598
1598
1599
1599
.. image:: ./images/breeze/output_setup_self-upgrade.svg
1600
1600
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_setup_self-upgrade.svg
@@ -1650,7 +1650,7 @@ Breeze requires certain resources to be available - disk, memory, CPU. When you
1650
1650
the resources are checked and information if there is enough resources is displayed. However you can
1651
1651
manually run resource check any time by ` ` breeze ci resource-check` ` command.
1652
1652
1653
- Those are all available flags of ` ` resource-check` ` command:
1653
+ These are all available flags of ` ` resource-check` ` command:
1654
1654
1655
1655
.. image:: ./images/breeze/output_ci_resource-check.svg
1656
1656
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_ci_resource-check.svg
@@ -1664,7 +1664,7 @@ When our CI runs a job, it needs all memory and disk it can have. We have a Bree
1664
1664
the memory and disk space used. You can also use it clear space locally but it performs a few operations
1665
1665
that might be a bit invasive - such are removing swap file and complete pruning of docker disk space used.
1666
1666
1667
- Those are all available flags of ` ` free-space` ` command:
1667
+ These are all available flags of ` ` free-space` ` command:
1668
1668
1669
1669
.. image:: ./images/breeze/output_ci_free-space.svg
1670
1670
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_ci_free-space.svg
@@ -1684,7 +1684,7 @@ by the root user, you can fix the ownership of those files by running :
1684
1684
1685
1685
breeze ci fix-ownership
1686
1686
1687
- Those are all available flags of ` ` fix-ownership` ` command:
1687
+ These are all available flags of ` ` fix-ownership` ` command:
1688
1688
1689
1689
.. image:: ./images/breeze/output_ci_fix-ownership.svg
1690
1690
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_ci_fix-ownership.svg
@@ -1705,7 +1705,7 @@ from the context of the commit/PR to be merged via stderr output.
1705
1705
More details about the algorithm used to pick the right tests and the available outputs can be
1706
1706
found in ` Selective Checks < dev/breeze/SELECTIVE_CHECKS.md> ` _.
1707
1707
1708
- Those are all available flags of ` ` selective-check` ` command:
1708
+ These are all available flags of ` ` selective-check` ` command:
1709
1709
1710
1710
.. image:: ./images/breeze/output_ci_selective-check.svg
1711
1711
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_ci_selective-check.svg
@@ -1719,7 +1719,7 @@ When our CI runs a job, it might be within one of several workflows. Information
1719
1719
is stored in GITHUB_CONTEXT. Rather than using some jq/bash commands, we retrieve the necessary information
1720
1720
(like PR labels, event_type, where the job runs on, job description and convert them into GA outputs.
1721
1721
1722
- Those are all available flags of ` ` get-workflow-info` ` command:
1722
+ These are all available flags of ` ` get-workflow-info` ` command:
1723
1723
1724
1724
.. image:: ./images/breeze/output_ci_get-workflow-info.svg
1725
1725
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_ci_get-workflow-info.svg
@@ -2020,7 +2020,7 @@ while publishing the documentation.
2020
2020
The flag ` ` --airflow-site-directory` ` takes the path of the cloned ` ` airflow-site` ` . The command will
2021
2021
not proceed if this is an invalid path.
2022
2022
2023
- Those are all available flags of ` ` release-management publish-docs` ` command:
2023
+ These are all available flags of ` ` release-management publish-docs` ` command:
2024
2024
2025
2025
.. image:: ./images/breeze/output_release-management_publish-docs.svg
2026
2026
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_release-management_publish-docs.svg
@@ -2064,7 +2064,7 @@ providers - you can mix apache-airflow, helm-chart and provider packages this wa
2064
2064
breeze release-management publish-docs --airflow-site-directory DIRECTORY apache.airflow apache.beam google
2065
2065
2066
2066
2067
- Those are all available flags of ``release-management add-back-references`` command:
2067
+ These are all available flags of ``release-management add-back-references`` command:
2068
2068
2069
2069
.. image:: .images/breeze/output_release-management_add-back-references.svg
2070
2070
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_release-management_add-back-references.svg
@@ -2109,7 +2109,7 @@ Constraints are generated separately for each python version and there are separ
2109
2109
providers. If you want to manage airflow separately and then add providers individually, you can
2110
2110
use those.
2111
2111
2112
- Those are all available flags of ``generate-constraints`` command:
2112
+ These are all available flags of ``generate-constraints`` command:
2113
2113
2114
2114
.. image:: ./images/breeze/output_release-management_generate-constraints.svg
2115
2115
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_release-management_generate-constraints.svg
@@ -2118,13 +2118,30 @@ Those are all available flags of ``generate-constraints`` command:
2118
2118
2119
2119
In case someone modifies setup.py, the scheduled CI Tests automatically upgrades and
2120
2120
pushes changes to the constraint files, however you can also perform test run of this locally using
2121
- the procedure described in `Refreshing CI Cache <dev/REFRESHING_CI_CACHE.md#manually-generating-constraint-files>`_
2121
+ the procedure described in the
2122
+ `Manually generating image cache and constraints <dev/MANUALLY_GENERATING_IMAGE_CACHE_AND_CONSTRAINTS.md>`_
2122
2123
which utilises multiple processors on your local machine to generate such constraints faster.
2123
2124
2124
2125
This bumps the constraint files to latest versions and stores hash of setup.py. The generated constraint
2125
2126
and setup.py hash files are stored in the ``files`` folder and while generating the constraints diff
2126
2127
of changes vs the previous constraint files is printed.
2127
2128
2129
+ Updating constraints
2130
+ """"""""""""""""""""
2131
+
2132
+ Sometimes (very rarely) we might want to update individual packages in constraints that we generated and
2133
+ tagged already in the past. This can be done using ``breeze release-management update-constraints`` command.
2134
+
2135
+ These are all available flags of ``update-constraints`` command:
2136
+
2137
+ .. image:: ./images/breeze/output_release-management_update-constraints.svg
2138
+ :target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output_release-management_update-constraints.svg
2139
+ :width: 100%
2140
+ :alt: Breeze update-constraints
2141
+
2142
+ You can read more details about what happens when you update constraints in the
2143
+ `Manually generating image cache and constraints <dev/MANUALLY_GENERATING_IMAGE_CACHE_AND_CONSTRAINTS.md>`_
2144
+
2128
2145
2129
2146
SBOM generation tasks
2130
2147
----------------------
@@ -2174,7 +2191,7 @@ keeps data in their own volume. Those volumes are persisted until ``breeze down`
2174
2191
You can also preserve the volumes by adding flag ` ` --preserve-volumes` ` when you run the command.
2175
2192
Then, next time when you start Breeze, it will have the data pre-populated.
2176
2193
2177
- Those are all available flags of ` ` down` ` command:
2194
+ These are all available flags of ` ` down` ` command:
2178
2195
2179
2196
.. image:: ./images/breeze/output-down.svg
2180
2197
:target: https://raw.githubusercontent.com/apache/airflow/main/images/breeze/output-down.svg
0 commit comments