potiuk commented on a change in pull request #8807:
URL: https://github.com/apache/airflow/pull/8807#discussion_r425137699
##########
File path: BREEZE.rst
##########
@@ -870,6 +872,78 @@ This is the current syntax for `./breeze <./breeze>`_:
####################################################################################################
+ Detailed usage for command: generate-backport-readme
+
+ breeze [FLAGS] generate-backport-readme -- <EXTRA_ARGS>
+
+ Prepares README.md files for backport packages. You can provide (after
--) optional version
+ in the form of YYYY.MM.DD, optionally followed by the list of packages
to generate readme for.
+ If the first parameter is not formatted as a date, then today is used
as version.
+ If no packages are specified, readme for all packages are generated.
+
+ Examples:
+
+ 'breeze generate-backport-readme' or
+ 'breeze generate-backport-readme -- 2020.05.10' or
+ 'breeze generate-backport-readme -- 2020.05.10 https google amazon'
+
+ General form:
+
+ 'breeze generate-backport-readme -- YYYY.MM.DD <PACKAGE_ID> ...'
+
+ * YYYY.MM.DD - is the CALVER version of the package to prepare. Note
that this date
+ cannot be earlier than the already released version (the script will
fail if it
+ will be). It can be set in the future anticipating the future
release date.
+
+ * <PACKAGE_ID> is usually directory in the airflow/providers folder
(for example
+ 'google' but in several cases, it might be one level deeper
separated with
+ '.' for example 'apache.hive'
+
+ Flags:
+
+ -v, --verbose
+ Show verbose information about executed commands (enabled by default
for running test).
+ Note that you can further increase verbosity and see all the
commands executed by breeze
+ by running 'export VERBOSE_COMMANDS="true"' before running breeze.
+
+
+
####################################################################################################
+
+
+ Detailed usage for command: prepare-backport-packages
+
+ breeze [FLAGS] prepare-backport-packages -- <EXTRA_ARGS>
+
+ Builds backport packages. You can provide (after --) optional list of
packages to prepare.
+ If no packages are specified, readme for all packages are generated.
+
+ Make sure to set the right version in
'./backport_packages/setup_backport_packages.py'
+
+ Examples:
+
+ 'breeze prepare-backport-packages' or
+ 'breeze prepare-backport-packages' -- google' or
+ 'breeze prepare-backport-packages' -- http google amazon'
Review comment:
REsolved.
----------------------------------------------------------------
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]
