potiuk commented on a change in pull request #9889:
URL: https://github.com/apache/airflow/pull/9889#discussion_r457278921
##########
File path: BREEZE.rst
##########
@@ -693,31 +693,37 @@ easily identify the location the problems with
documentation originated from.
</a>
</div>
-Generating requirements
------------------------
+Generating constraints
+----------------------
-Whenever you modify and commit setup.py, you need to re-generate requirement
files. Those requirement
-files ara stored separately for each python version in the ``requirements``
folder. Those are
-constraints rather than requirements as described in detail in the
-`CONTRIBUTING.rst <CONTRIBUTING.rst#pinned-requirement-files>`_ contributing
documentation.
+Whenever setup.py gets modified, the CI master job will re-generate constraint
files. Those constraint
+files ara stored in separated orphan branches: ``constraints-master`` and
``constraint-1-10``.
+They are stored separately for each python version. Those are
+constraint files as described in detail in the
+`CONTRIBUTING.rst <CONTRIBUTING.rst#pinned-constraint-files>`_ contributing
documentation.
-In case you modify setup.py you need to update the requirements - for every
python version supported.
+In case someone modifies setup.py, the ``CRON`` scheduled CI build
automatically upgrades and
+pushes changed to the constraint files, however you can also perform test run
of this locally using
+``generate-constraints`` command of Breeze.
.. code-block:: bash
- ./breeze generate-requirements --python 3.6
+ ./breeze generate-constraints --python 3.6
.. code-block:: bash
- ./breeze generate-requirements --python 3.7
+ ./breeze generate-constraints --python 3.7
.. code-block:: bash
- ./breeze generate-requirements --python 3.8
+ ./breeze generate-constraints --python 3.8
+This bumps the constraint files to latest versions and stores hash of
setup.py. The generated constraint
+and setup.py hash files are stored in the ``files`` folder and while
generating the constraints diff
+of changes vs the previous constraint files is printed.
-This bumps requirements to latest versions and stores hash of setup.py so that
we are automatically
-upgrading the requirements as we add new ones.
+Note - the movie below shows previous version of the command
``generate-requirements`` that is not valid
+any-more.
Review comment:
REmoved
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
