[AIRFLOW-5826] Added auto-generation of breeze output in BREEZE.rst (#6490)
This is needed to keep breeze --help in sync with the documentation. It makes it easier for the follow-up changes needed for production image to keep the docs in sync with the code.
This commit is contained in:
Jarek Potiuk
GitHub
Родитель
bb0161655c
Коммит
d2595de91d
|
|
@ -190,6 +190,13 @@ repos:
|
|||
entry: "./scripts/ci/pre_commit_lint_dockerfile.sh"
|
||||
files: ^Dockerfile.*$
|
||||
pass_filenames: true
|
||||
- id: update-breeze-file
|
||||
name: Update output of breeze command in BREEZE.rst
|
||||
entry: "./scripts/ci/pre_commit_breeze_cmd_line.sh"
|
||||
language: system
|
||||
files: ^BREEZE.rst$|^breeze$|^breeze-complete$
|
||||
pass_filenames: false
|
||||
require_serial: true
|
||||
- id: mypy
|
||||
name: Run mypy
|
||||
language: system
|
||||
|
|
|
|||
252
BREEZE.rst
252
BREEZE.rst
|
|
@ -839,167 +839,185 @@ Airflow Breeze Syntax
|
|||
|
||||
This is the current syntax for `./breeze <./breeze>`_:
|
||||
|
||||
.. START BREEZE HELP MARKER
|
||||
|
||||
.. code-block:: text
|
||||
|
||||
Usage: breeze [FLAGS] \
|
||||
[-k]|[-S <STATIC_CHECK>]|[-F <STATIC_CHECK>]|[-O]|[-e]|[-a]|[-b]|[-t <TARGET>]|[-x <COMMAND>]|[-d <COMMAND>] \
|
||||
-- <EXTRA_ARGS>
|
||||
|
||||
Commands
|
||||
|
||||
By default, the ``breeze`` script enters an IT environment and drops you to a bash shell,
|
||||
but you can also choose commands to run specific actions instead:
|
||||
Usage: breeze [FLAGS] \
|
||||
[-k]|[-S <STATIC_CHECK>]|[-F <STATIC_CHECK>]|[-O]|[-e]|[-a]|[-b]|[-t <TARGET>]|[-x <COMMAND>]|[-d <COMMAND>] \
|
||||
-- <EXTRA_ARGS>
|
||||
|
||||
-k, --stop-environment
|
||||
Stops running a Docker Compose environment. When you start the environment, the Docker
|
||||
containers continue running so that startup time is shorter. But they take quite a lot of
|
||||
memory and CPU. This command stops all running containers in the environment.
|
||||
The swiss-knife-army tool for Airflow testings. It allows to perform various test tasks:
|
||||
|
||||
-O, --build-docs
|
||||
Builds documentation.
|
||||
* Enter interactive environment when no command flags are specified (default behaviour)
|
||||
* Stop the interactive environment with -k, --stop-environment command
|
||||
* Run static checks - either for currently staged change or for all files with
|
||||
-S, --static-check or -F, --static-check-all-files commanbd
|
||||
* Build documentation with -O, --build-docs command
|
||||
* Setup local virtualenv with -e, --setup-virtualenv command
|
||||
* Setup autocomplete for itself with -a, --setup-autocomplete command
|
||||
* Build docker image with -b, --build-only command
|
||||
* Run test target specified with -t, --test-target connad
|
||||
* Execute arbitrary command in the test environmenrt with -x, --execute-command command
|
||||
* Execute arbitrary docker-compose command with -d, --docker-compose command
|
||||
|
||||
-S, --static-check <STATIC_CHECK>
|
||||
Runs selected static checks for currently changed files. Specify a static check that
|
||||
you would like to run or use 'all' to run all checks. One of
|
||||
[ all all-but-pylint check-hooks-apply check-merge-conflict check-executables-have-shebangs
|
||||
check-xml detect-private-key doctoc end-of-file-fixer flake8 forbid-tabs insert-license
|
||||
check-apache-license lint-dockerfile mixed-line-ending mypy pylint shellcheck].
|
||||
You can pass extra arguments including options to the pre-commit framework as
|
||||
<EXTRA_ARGS> passed after --. For example:
|
||||
** Commands
|
||||
|
||||
'./breeze --static-check mypy' or
|
||||
'./breeze --static-check mypy -- --files tests/core.py'
|
||||
By default the script enters IT environment and drops you to bash shell,
|
||||
but you can also choose one of the commands to run specific actions instead:
|
||||
|
||||
You can see all the options by adding --help EXTRA_ARG:
|
||||
-k, --stop-environment
|
||||
Bring down running docker compose environment. When you start the environment, the docker
|
||||
containers will continue running so that startup time is shorter. But they take quite a lot of
|
||||
memory and CPU. This command stops all running containers from the environment.
|
||||
|
||||
'./breeze --static-check mypy -- --help'
|
||||
-O, --build-docs
|
||||
Build documentation.
|
||||
|
||||
-F, --static-check-all-files <STATIC_CHECK>
|
||||
Runs selected static checks for all applicable files. Specify a static check that
|
||||
you would like to run or use 'all' to run all checks. One of
|
||||
[ all all-but-pylint check-hooks-apply check-merge-conflict check-executables-have-shebangs
|
||||
check-xml detect-private-key doctoc end-of-file-fixer flake8 forbid-tabs insert-license
|
||||
check-apache-license lint-dockerfile mixed-line-ending mypy pylint shellcheck].
|
||||
You can pass extra arguments including options to the pre-commit framework as
|
||||
<EXTRA_ARGS> passed after --. For example:
|
||||
-S, --static-check <STATIC_CHECK>
|
||||
Run selected static checks for currently changed files. You should specify static check that
|
||||
you would like to run or 'all' to run all checks. One of
|
||||
[ all all-but-pylint check-hooks-apply check-merge-conflict check-executables-have-shebangs check-xml detect-private-key doctoc end-of-file-fixer flake8 forbid-tabs insert-license check-apache-license lint-dockerfile mixed-line-ending mypy pylint shellcheck].
|
||||
You can pass extra arguments including options to to the pre-commit framework as
|
||||
<EXTRA_ARGS> passed after --. For example:
|
||||
|
||||
'./breeze --static-check-all-files mypy' or
|
||||
'./breeze --static-check-all-files mypy -- --verbose'
|
||||
'./breeze --static-check mypy' or
|
||||
'./breeze --static-check mypy -- --files tests/core.py'
|
||||
|
||||
You can see all the options by adding --help EXTRA_ARG:
|
||||
You can see all the options by adding --help EXTRA_ARG:
|
||||
|
||||
'./breeze --static-check-all-files mypy -- --help'
|
||||
'./breeze --static-check mypy -- --help'
|
||||
|
||||
-e, --initialize-local-virtualenv
|
||||
Initializes a locally created virtualenv installing all dependencies of Airflow.
|
||||
This local virtualenv can be used to aid autocompletion and IDE support as
|
||||
well as run unit tests directly from the IDE. You need to have virtualenv
|
||||
activated before running this command.
|
||||
-F, --static-check-all-files <STATIC_CHECK>
|
||||
Run selected static checks for all applicable files. You should specify static check that
|
||||
you would like to run or 'all' to run all checks. One of
|
||||
[ all all-but-pylint check-hooks-apply check-merge-conflict check-executables-have-shebangs check-xml detect-private-key doctoc end-of-file-fixer flake8 forbid-tabs insert-license check-apache-license lint-dockerfile mixed-line-ending mypy pylint shellcheck].
|
||||
You can pass extra arguments including options to the pre-commit framework as
|
||||
<EXTRA_ARGS> passed after --. For example:
|
||||
|
||||
-a, --setup-autocomplete
|
||||
Sets up autocompletion for breeze commands. Once you do it, you need to re-enter the bash
|
||||
shell. When you type the breeze command, <TAB> will autocomplete parameters and values.
|
||||
'./breeze --static-check-all-files mypy' or
|
||||
'./breeze --static-check-all-files mypy -- --verbose'
|
||||
|
||||
-b, --build-only
|
||||
Only builds Docker images but does not enter the airflow-testing Docker container.
|
||||
You can see all the options by adding --help EXTRA_ARG:
|
||||
|
||||
-t, --test-target <TARGET>
|
||||
Runs the specified unit test target. You can specify multiple
|
||||
targets separated with commas. The <EXTRA_ARGS> passed after -- are treated
|
||||
as additional options passed to nosetest. For example:
|
||||
'./breeze --static-check-all-files mypy -- --help'
|
||||
|
||||
'./breeze --test-target tests.core -- --logging-level=DEBUG'
|
||||
-e, --initialize-local-virtualenv
|
||||
Initializes locally created virtualenv installing all dependencies of Airflow.
|
||||
This local virtualenv can be used to aid autocompletion and IDE support as
|
||||
well as run unit tests directly from the IDE. You need to have virtualenv
|
||||
activated before running this command.
|
||||
|
||||
-x, --execute-command <COMMAND>
|
||||
Runs the specified command instead of entering the environment. The command is run using
|
||||
'bash -c "<command with args>". If you need to pass arguments to your command, you need
|
||||
to pass them together with the command surrounded with " or '. Alternatively, you can pass
|
||||
arguments as <EXTRA_ARGS> passed after --. For example:
|
||||
-a, --setup-autocomplete
|
||||
Sets up autocomplete for breeze commands. Once you do it you need to re-enter the bash
|
||||
shell and when typing breeze command <TAB> will provide autocomplete for parameters and values.
|
||||
|
||||
'./breeze --execute-command "ls -la"' or
|
||||
'./breeze --execute-command ls -- --la'
|
||||
-b, --build-only
|
||||
Only build docker images but do not enter the airflow-testing docker container.
|
||||
|
||||
-d, --docker-compose <COMMAND>
|
||||
Runs the docker-compose command instead of entering the environment. Use the 'help' command
|
||||
to see available commands. The <EXTRA_ARGS> passed after -- are treated
|
||||
as additional options passed to docker-compose. For example:
|
||||
-t, --test-target <TARGET>
|
||||
Run the specified unit test target. There might be multiple
|
||||
targets specified separated with comas. The <EXTRA_ARGS> passed after -- are treated
|
||||
as additional options passed to nosetest. For example:
|
||||
|
||||
'./breeze --docker-compose pull -- --ignore-pull-failures'
|
||||
'./breeze --test-target tests.core -- --logging-level=DEBUG'
|
||||
|
||||
** General flags
|
||||
-x, --execute-command <COMMAND>
|
||||
Run chosen command instead of entering the environment. The command is run using
|
||||
'bash -c "<command with args>" if you need to pass arguments to your command, you need
|
||||
to pass them together with command surrounded with " or '. Alternatively you can pass arguments as
|
||||
<EXTRA_ARGS> passed after --. For example:
|
||||
|
||||
-h, --help
|
||||
Shows this help message.
|
||||
'./breeze --execute-command "ls -la"' or
|
||||
'./breeze --execute-command ls -- --la'
|
||||
|
||||
-P, --python <PYTHON_VERSION>
|
||||
Specifies a Python version for the image. This is always major/minor version.
|
||||
One of [ 3.5 3.6 3.7 ]. Default is the python3 or python on the path.
|
||||
-d, --docker-compose <COMMAND>
|
||||
Run docker-compose command instead of entering the environment. Use 'help' command
|
||||
to see available commands. The <EXTRA_ARGS> passed after -- are treated
|
||||
as additional options passed to docker-compose. For example
|
||||
|
||||
-E, --env <ENVIRONMENT>
|
||||
Specifies an environment for tests. The environment determines which types of tests can be run.
|
||||
One of [ docker kubernetes ]. Default: docker.
|
||||
'./breeze --docker-compose pull -- --ignore-pull-failures'
|
||||
|
||||
-B, --backend <BACKEND>
|
||||
Specifies backend for tests. It determines which database is used.
|
||||
One of [ sqlite mysql postgres ]. Default: sqlite.
|
||||
** General flags
|
||||
|
||||
-K, --kubernetes-version <KUBERNETES_VERSION>
|
||||
Specifies Kubernetes version. The flag is applicable if the 'kubernetes' environment is used.
|
||||
One of [ v1.13.0 ]. Default: v1.13.0.
|
||||
-h, --help
|
||||
Shows this help message.
|
||||
|
||||
-M, --kubernetes-mode <KUBERNETES_MODE>
|
||||
Specifies Kubernetes mode. The flag is applicable if the 'kubernetes' environment is used.
|
||||
One of [ persistent_mode git_mode ]. Default: git_mode.
|
||||
-P, --python <PYTHON_VERSION>
|
||||
Python version used for the image. This is always major/minor version.
|
||||
One of [ 3.5 3.6 3.7 ]. Default is the python3 or python on the path.
|
||||
|
||||
-s, --skip-mounting-source-volume
|
||||
Skips mounting local volume with sources. You get exactly what is in the
|
||||
Docker image rather than your current local sources of Airflow.
|
||||
-E, --env <ENVIRONMENT>
|
||||
Environment to use for tests. It determines which types of tests can be run.
|
||||
One of [ docker kubernetes ]. Default: docker
|
||||
|
||||
-v, --verbose
|
||||
Shows verbose information about executed commands (enabled by default for running tests).
|
||||
-B, --backend <BACKEND>
|
||||
Backend to use for tests - it determines which database is used.
|
||||
One of [ sqlite mysql postgres ]. Default: sqlite
|
||||
|
||||
-y, --assume-yes
|
||||
Assumes 'yes' answer to all questions.
|
||||
-K, --kubernetes-version <KUBERNETES_VERSION>
|
||||
Kubernetes version - only used in case of 'kubernetes' environment.
|
||||
One of [ v1.13.0 ]. Default: v1.13.0
|
||||
|
||||
-n, --assume-no
|
||||
Assumes 'no' answer to all questions.
|
||||
-M, --kubernetes-mode <KUBERNETES_MODE>
|
||||
Kubernetes mode - only used in case of 'kubernetes' environment.
|
||||
One of [ persistent_mode git_mode ]. Default: git_mode
|
||||
|
||||
-C, --toggle-suppress-cheatsheet
|
||||
Toggles on/off the cheatsheet displayed before starting bash shell.
|
||||
-s, --skip-mounting-source-volume
|
||||
Skips mounting local volume with sources - you get exactly what is in the
|
||||
docker image rather than your current local sources of airflow.
|
||||
|
||||
-A, --toggle-suppress-asciiart
|
||||
Toggles on/off asciiart displayed before starting bash shell.
|
||||
-v, --verbose
|
||||
Show verbose information about executed commands (enabled by default for running test)
|
||||
|
||||
** Dockerfile management flags
|
||||
-y, --assume-yes
|
||||
Assume 'yes' answer to all questions.
|
||||
|
||||
-D, --dockerhub-user
|
||||
Specifies a Docker Hub user that pulls, pushes and builds images. Default: apache.
|
||||
-n, --assume-no
|
||||
Assume 'no' answer to all questions.
|
||||
|
||||
-H, --dockerhub-repo
|
||||
Specifies a Docker Hub repository used to pull, push, and build images. Default: airflow.
|
||||
-C, --toggle-suppress-cheatsheet
|
||||
Toggles on/off cheatsheet displayed before starting bash shell
|
||||
|
||||
-r, --force-build-images
|
||||
Forces building the local Docker images. The images are rebuilt
|
||||
automatically for the first time or when changes are detected in
|
||||
package-related files, but you can force it using this flag.
|
||||
-A, --toggle-suppress-asciiart
|
||||
Toggles on/off asciiart displayed before starting bash shell
|
||||
|
||||
-R, --force-build-images-clean
|
||||
Forces building images without cache. This removes the pulled or built images
|
||||
and starts building images from scratch. This may take time.
|
||||
** Dockerfile management flags
|
||||
|
||||
-p, --force-pull-images
|
||||
Forces pulling images from Docker Hub before building to populate the cache. The
|
||||
images are pulled by default only for the first time you run the
|
||||
environment. Later the locally built images are used from the cache.
|
||||
-D, --dockerhub-user
|
||||
DockerHub user used to pull, push and build images. Default: apache.
|
||||
|
||||
-u, --push-images
|
||||
Uploads the images to Docker Hub after rebuilding.
|
||||
It is useful in case you use your own Docker Hub user to store images and you want
|
||||
to build them locally. Note that you need to use 'docker login' before you upload images.
|
||||
-H, --dockerhub-repo
|
||||
DockerHub repository used to pull, push, build images. Default: airflow.
|
||||
|
||||
-r, --force-build-images
|
||||
Forces building of the local docker images. The images are rebuilt
|
||||
automatically for the first time or when changes are detected in
|
||||
package-related files, but you can force it using this flag.
|
||||
|
||||
-R, --force-build-images-clean
|
||||
Force build images without cache. This will remove the pulled or build images
|
||||
and start building images from scratch. This might take a long time.
|
||||
|
||||
-p, --force-pull-images
|
||||
Forces pulling of images from DockerHub before building to populate cache. The
|
||||
images are pulled by default only for the first time you run the
|
||||
environment, later the locally build images are used as cache.
|
||||
|
||||
-u, --push-images
|
||||
After building - uploads the images to DockerHub
|
||||
It is useful in case you use your own DockerHub user to store images and you want
|
||||
to build them locally. Note that you need to use 'docker login' before you upload images.
|
||||
|
||||
-c, --cleanup-images
|
||||
Cleanup your local docker cache of the airflow docker images. This will not reclaim space in
|
||||
docker cache. You need to 'docker system prune' (optionally with --all) to reclaim that space.
|
||||
|
||||
|
||||
.. END BREEZE HELP MARKER
|
||||
|
||||
-c, --cleanup-images
|
||||
Cleans up your local Docker cache of the Airflow Docker images. This does not reclaim space in the
|
||||
Docker cache. You need to 'docker system prune' (optionally with --all) to reclaim that space.
|
||||
|
||||
Convenience Scripts
|
||||
-------------------
|
||||
|
|
|
|||
|
|
@ -55,13 +55,9 @@ export DOCKERHUB_REPO=${DOCKERHUB_REPO:="airflow"}
|
|||
|
||||
# if AIRFLOW_CONTAINER_BRANCH_NAME is not set it will be set to either SOURCE_BRANCH
|
||||
# (if overridden by configuration) or default branch configured in /common/_default_branch.sh
|
||||
SOURCE_BRANCH=${SOURCE_BRANCH:=${DEFAULT_BRANCH}}
|
||||
export SOURCE_BRANCH=${SOURCE_BRANCH:=${DEFAULT_BRANCH}}
|
||||
|
||||
AIRFLOW_CONTAINER_BRANCH_NAME=${AIRFLOW_CONTAINER_BRANCH_NAME:=${SOURCE_BRANCH}}
|
||||
|
||||
echo
|
||||
echo "Branch: ${AIRFLOW_CONTAINER_BRANCH_NAME}"
|
||||
echo
|
||||
export AIRFLOW_CONTAINER_BRANCH_NAME=${AIRFLOW_CONTAINER_BRANCH_NAME:=${SOURCE_BRANCH}}
|
||||
|
||||
# IMAGE_NAME might come from DockerHub and we decide which PYTHON_VERSION to use based on it (see below)
|
||||
# In case IMAGE_NAME is not set we determine PYTHON_VERSION based on the default python on the path
|
||||
|
|
@ -71,15 +67,8 @@ echo
|
|||
# to a different CI system and start pushing images to DockerHub rather than build it there.
|
||||
export BASE_IMAGE_NAME=${IMAGE_NAME:=${DOCKERHUB_USER}/${DOCKERHUB_REPO}:${AIRFLOW_CONTAINER_BRANCH_NAME}-python${PYTHON_VERSION:-3.5}}
|
||||
|
||||
echo
|
||||
echo "BASE_IMAGE_NAME=${BASE_IMAGE_NAME:=} (final image will have -ci, -ci-slim suffixes)"
|
||||
echo
|
||||
|
||||
# Remove index.docker.io/ prefix as it is added by default by DockerHub
|
||||
export LOCAL_BASE_IMAGE_NAME=${BASE_IMAGE_NAME#index.docker.io/}
|
||||
echo
|
||||
echo "LOCAL_BASE_IMAGE_NAME=${LOCAL_BASE_IMAGE_NAME}"
|
||||
echo
|
||||
|
||||
if [[ ! ${LOCAL_BASE_IMAGE_NAME} == ${DOCKERHUB_USER}/${DOCKERHUB_REPO}* ]]; then
|
||||
echo >&2
|
||||
|
|
@ -89,16 +78,10 @@ if [[ ! ${LOCAL_BASE_IMAGE_NAME} == ${DOCKERHUB_USER}/${DOCKERHUB_REPO}* ]]; the
|
|||
fi
|
||||
|
||||
# Extract IMAGE_TAG from LOCAL_BASE_IMAGE_NAME (apache/airflow:master-python3.6 -> master-python3.6)
|
||||
IMAGE_TAG=${LOCAL_BASE_IMAGE_NAME##${DOCKERHUB_USER}/${DOCKERHUB_REPO}:}
|
||||
echo
|
||||
echo "Image tag: ${IMAGE_TAG}"
|
||||
echo
|
||||
export IMAGE_TAG=${LOCAL_BASE_IMAGE_NAME##${DOCKERHUB_USER}/${DOCKERHUB_REPO}:}
|
||||
|
||||
# Extract TAG_PREFIX from IMAGE_TAG (master-python3.6 -> master)
|
||||
TAG_PREFIX=${IMAGE_TAG%-*}
|
||||
echo
|
||||
echo "Image tag prefix: ${TAG_PREFIX}"
|
||||
echo
|
||||
export TAG_PREFIX=${IMAGE_TAG%-*}
|
||||
|
||||
# By that time no matter if we got the version from the IMAGE_NAME or we built
|
||||
# IMAGE_NAME with PYTHON_VERSION - the LOCAL_BASE_IMAGE_NAME should end with the correct pythonX.Y
|
||||
|
|
@ -107,10 +90,6 @@ echo
|
|||
# will produce LONG_PYTHON_VERSION_FROM_IMAGE=python3.6
|
||||
export LONG_PYTHON_VERSION_FROM_IMAGE="${LOCAL_BASE_IMAGE_NAME##*-}"
|
||||
|
||||
echo
|
||||
echo "LONG_PYTHON_VERSION_FROM_IMAGE=${LONG_PYTHON_VERSION_FROM_IMAGE}"
|
||||
echo
|
||||
|
||||
# Verify that python version retrieved from image follows the expected pattern of python3.Y
|
||||
if [[ ! ${LONG_PYTHON_VERSION_FROM_IMAGE} =~ python[23]\.[0-9]+ ]]; then
|
||||
echo >&2
|
||||
|
|
@ -123,7 +102,3 @@ fi
|
|||
|
||||
# Unless python_version is forced, read actual python version from IMAGE NAME
|
||||
export PYTHON_VERSION=${LONG_PYTHON_VERSION_FROM_IMAGE#python}
|
||||
|
||||
echo
|
||||
echo "PYTHON_VERSION=${PYTHON_VERSION}"
|
||||
echo
|
||||
|
|
|
|||
|
|
@ -31,6 +31,8 @@ build_image_on_ci
|
|||
|
||||
KUBERNETES_VERSION=${KUBERNETES_VERSION:=""}
|
||||
|
||||
mkdir -p "${AIRFLOW_SOURCES}/files"
|
||||
|
||||
sudo pip install pre-commit
|
||||
|
||||
script_end
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ RES=$?
|
|||
set +x
|
||||
if [[ "${RES}" != "0" ]]; then
|
||||
if [[ -f "${XUNIT_FILE:=}" ]]; then
|
||||
SEPARATOR_WIDTH=$(tput cols)
|
||||
SEPARATOR_WIDTH=${SEPARATOR_WIDTH=$(tput cols)}
|
||||
echo
|
||||
printf '=%.0s' $(seq "${SEPARATOR_WIDTH}")
|
||||
echo
|
||||
|
|
|
|||
|
|
@ -0,0 +1,48 @@
|
|||
#!/usr/bin/env bash
|
||||
# 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.
|
||||
|
||||
set -uo pipefail
|
||||
|
||||
MY_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
|
||||
|
||||
TMP_FILE=$(mktemp)
|
||||
TMP_OUTPUT=$(mktemp)
|
||||
|
||||
cd "${MY_DIR}/../../" || exit;
|
||||
|
||||
echo "
|
||||
.. code-block:: text
|
||||
" >"${TMP_FILE}"
|
||||
|
||||
export SEPARATOR_WIDTH=100
|
||||
export AIRFLOW_CI_SILENT="true"
|
||||
./breeze --help | sed 's/^/ /' | sed 's/ *$//' >>"${TMP_FILE}"
|
||||
|
||||
BREEZE_RST_FILE="${MY_DIR}/../../BREEZE.rst"
|
||||
|
||||
LEAD='^ \.\. START BREEZE HELP MARKER$'
|
||||
TAIL='^ \.\. END BREEZE HELP MARKER$'
|
||||
|
||||
BEGIN_GEN=$(grep -n "${LEAD}" <"${BREEZE_RST_FILE}" | sed 's/\(.*\):.*/\1/g')
|
||||
END_GEN=$(grep -n "${TAIL}" <"${BREEZE_RST_FILE}" | sed 's/\(.*\):.*/\1/g')
|
||||
cat <(head -n "${BEGIN_GEN}" "${BREEZE_RST_FILE}") \
|
||||
"${TMP_FILE}" \
|
||||
<(tail -n +"${END_GEN}" "${BREEZE_RST_FILE}") \
|
||||
>"${TMP_OUTPUT}"
|
||||
|
||||
mv "${TMP_OUTPUT}" "${BREEZE_RST_FILE}"
|
||||
Загрузка…
Ссылка в новой задаче