This is an automated email from the ASF dual-hosted git repository. potiuk pushed a commit to branch v2-0-test in repository https://gitbox.apache.org/repos/asf/airflow.git
commit fb8f479f01e5ffe55109e54dcadb1784898bb87d Author: John Bampton <[email protected]> AuthorDate: Sun Feb 28 19:25:15 2021 +1000 chore: fix case of GitHub (#14525) (cherry picked from commit 1c694318ac3ede10afe09fd1669dacec0b6a6cb2) --- CI.rst | 20 ++++++++++---------- COMMITTERS.rst | 2 +- CONTRIBUTORS_QUICK_START.rst | 4 ++-- IMAGES.rst | 8 ++++---- scripts/ci/libraries/_build_images.sh | 14 +++++++------- scripts/ci/libraries/_push_pull_remove_images.sh | 4 ++-- scripts/ci/libraries/_script_init.sh | 2 +- scripts/ci/libraries/_start_end.sh | 4 ++-- scripts/in_container/_in_container_utils.sh | 4 ++-- scripts/in_container/check_environment.sh | 2 +- scripts/in_container/prod/entrypoint_prod.sh | 2 +- 11 files changed, 33 insertions(+), 33 deletions(-) diff --git a/CI.rst b/CI.rst index de5e17c..37234bc 100644 --- a/CI.rst +++ b/CI.rst @@ -101,18 +101,18 @@ We can use either of the two available GitHub Container registries as cache: Those two images have different naming schemas. See `Images documentation <IMAGES.rst>`_ for details. You can choose which registry should be used by the repository by setting ``OVERRIDE_GITHUB_REGISTRY`` secret -to either ``docker.pkg.github.com`` for Github Package Registry or ``ghcr.io`` for GitHub Container Registry. -Default is the Github Package Registry one. The Pull Request forks have no access to the secret but they +to either ``docker.pkg.github.com`` for GitHub Package Registry or ``ghcr.io`` for GitHub Container Registry. +Default is the GitHub Package Registry one. The Pull Request forks have no access to the secret but they auto-detect the registry used when they wait for the images. -You can interact with the Github Registry images (pull/push) via `Breeze <BREEZE.rst>`_ - you can -pass ``--github-registry`` flag wih either ``docker.pkg.github.com`` for Github Package Registry or +You can interact with the GitHub Registry images (pull/push) via `Breeze <BREEZE.rst>`_ - you can +pass ``--github-registry`` flag wih either ``docker.pkg.github.com`` for GitHub Package Registry or ``ghcr.io`` for GitHub Container Registry and pull/push operations will be performed using the chosen registry, using appropriate naming convention. This allows building and pushing the images locally by committers who have access to push/pull those images. -Github Container Registry Token +GitHub Container Registry Token ------------------------------- Unlike GitHub Packages, GitHub Registry requires a personal access token added as ``PAT_CR`` secret in order @@ -430,7 +430,7 @@ DockerHub registry or change the GitHub registry to interact with and use your o ``GITHUB_REPOSITORY`` and providing your own GitHub Username and Token. Currently we are using GitHub Packages to cache images for the build. GitHub Packages are "legacy" -storage of binary artifacts for GitHub and as of September 2020 they introduced Github Container Registry +storage of binary artifacts for GitHub and as of September 2020 they introduced GitHub Container Registry as more stable, easier to manage replacement for container storage. It includes complete self-management of the images including permission management, public access, retention management and many more. @@ -438,9 +438,9 @@ More about it here: https://github.blog/2020-09-01-introducing-github-container-registry/ -Recently we started to experience unstable behaviour of the Github Packages ('unknown blob' +Recently we started to experience unstable behaviour of the GitHub Packages ('unknown blob' and manifest v1 vs. v2 when pushing images to it). So together with ASF we proposed to -enable Github Container Registry and it happened as of January 2020. +enable GitHub Container Registry and it happened as of January 2020. More about it in https://issues.apache.org/jira/browse/INFRA-20959 @@ -486,10 +486,10 @@ the model of permission management is not the same for Container Registry as it | | | default, can be commit SHA or RUN_ID. | +--------------------------------+---------------------------+----------------------------------------------+ -Authentication in Github Registry +Authentication in GitHub Registry ================================= -We are currently in the process of testing using Github Container Registry as cache for our images during +We are currently in the process of testing using GitHub Container Registry as cache for our images during the CI process. The default registry is set to "GitHub Packages", but we are testing the GitHub Container Registry. In case of GitHub Packages, authentication uses GITHUB_TOKEN mechanism. Authentication is needed for both pushing the images (WRITE) and pulling them (READ) - which means that GitHub token diff --git a/COMMITTERS.rst b/COMMITTERS.rst index 3e0c735..0ca8769 100644 --- a/COMMITTERS.rst +++ b/COMMITTERS.rst @@ -139,7 +139,7 @@ Prerequisites General prerequisites that we look for in all candidates: 1. Consistent contribution over last few months -2. Visibility on discussions on the dev mailing list, Slack channels or Github issues/discussions +2. Visibility on discussions on the dev mailing list, Slack channels or GitHub issues/discussions 3. Contributions to community health and project's sustainability for the long-term 4. Understands contributor/committer guidelines: `Contributors' Guide <https://github.com/apache/airflow/blob/master/CONTRIBUTING.rst>`__ diff --git a/CONTRIBUTORS_QUICK_START.rst b/CONTRIBUTORS_QUICK_START.rst index 38256ac..1ced771 100644 --- a/CONTRIBUTORS_QUICK_START.rst +++ b/CONTRIBUTORS_QUICK_START.rst @@ -750,7 +750,7 @@ tests are applied when you commit your code. <div align="center" style="padding-bottom:20px"> <img src="images/quick_start/ci_tests.png" - alt="CI tests Github"> + alt="CI tests GitHub"> </div> @@ -939,7 +939,7 @@ Contribution guide Raising Pull Request -------------------- -1. Go to your Github account and open your fork project and click on Branches +1. Go to your GitHub account and open your fork project and click on Branches .. raw:: html diff --git a/IMAGES.rst b/IMAGES.rst index c6d09b0..3011b28 100644 --- a/IMAGES.rst +++ b/IMAGES.rst @@ -229,10 +229,10 @@ Choosing image registry By default images are pulled and pushed from and to DockerHub registry when you use Breeze's push-image or build commands. But as described in `CI Documentaton <CI.rst>`_, you can choose different image -registry by setting ``GITHUB_REGISTRY`` to ``docker.pkg.github.com`` for Github Package Registry or +registry by setting ``GITHUB_REGISTRY`` to ``docker.pkg.github.com`` for GitHub Package Registry or ``ghcr.io`` for GitHub Container Registry. -Default is the Github Package Registry one. The Pull Request forks have no access to the secret but they +Default is the GitHub Package Registry one. The Pull Request forks have no access to the secret but they auto-detect the registry used when they wait for the images. Our images are named like that: @@ -271,7 +271,7 @@ image name if DockerHub is not used as registry). Also GitHub has its own struct each project has its own registry naming convention that should be followed. The name of images for GitHub registry are different as they must follow limitation of the registry used. -We are still using Github Packages as registry, but we are in the process of testing and switching +We are still using GitHub Packages as registry, but we are in the process of testing and switching to GitHub Container Registry, and the naming conventions are slightly different (GitHub Packages required all packages to have "organization/repository/" URL prefix ("apache/airflow/", where in GitHub Container Registry, all images are in "organization" not in "repository" and they are all @@ -432,7 +432,7 @@ It first pre-installs them from the right GitHub branch and only after that fina done from either local sources or remote location (PIP or GitHub repository). Customizing the image -..................... +--------------------- Customizing the image is an alternative way of adding your own dependencies to the image. diff --git a/scripts/ci/libraries/_build_images.sh b/scripts/ci/libraries/_build_images.sh index 6e0903a..be4833d 100644 --- a/scripts/ci/libraries/_build_images.sh +++ b/scripts/ci/libraries/_build_images.sh @@ -402,16 +402,16 @@ function build_images::get_docker_image_names() { export BUILT_CI_IMAGE_FLAG_FILE="${BUILD_CACHE_DIR}/${BRANCH_NAME}/.built_${PYTHON_MAJOR_MINOR_VERSION}" # This is 1-1 mapping of image names of Apache Airflow stored in DockerHub vs. the same images stored - # in Github Registries (either Github Container Registry or Github Packages) + # in GitHub Registries (either GitHub Container Registry or GitHub Packages) # # We have to apply naming conventions used by the registries and keep multiple RUN_ID tags. We use # common suffix ('gcr-v1') to be able to switch to different set of cache images if needed - # - for example when some images gets broken (might happen with Github Actions Registries) or when + # - for example when some images gets broken (might happen with GitHub Actions Registries) or when # the storage capacity per image is reached (though it is apparently unlimited) # # Some examples: # - # In case of Github Container Registry: + # In case of GitHub Container Registry: # # * Prod Image: "apache/airflow:master-python3.8" -> "apache/airflow-master-python3.8-gcr-v1:<RUN_ID>" # * Prod build image: "apache/airflow:master-python3.8-build" -> "apache/airflow-master-python3.8-build-gcr-v1:<RUN_ID>" @@ -422,7 +422,7 @@ function build_images::get_docker_image_names() { # # "apache/airflow:python-3.6 -> "apache/airflow-python-gcr-v1:3.6-slim-buster-<RUN_ID>" # - # In case of Github Packages image must be part of the repository: + # In case of GitHub Packages image must be part of the repository: # # * Prod Image: "apache/airflow:master-python3.8" -> "apache/airflow/master-python3.8-gcr-v1:<RUN_ID>" # * Prod build image: "apache/airflow:master-python3.8-build" -> "apache/airflow/master-python3.8-build-gcr-v1:<RUN_ID>" @@ -462,7 +462,7 @@ function build_images::get_docker_image_names() { # Also enable experimental features of docker (we need `docker manifest` command) function build_image::configure_github_docker_registry() { if [[ ${USE_GITHUB_REGISTRY} == "true" ]]; then - start_end::group_start "Determine Github Registry token used and login if needed" + start_end::group_start "Determine GitHub Registry token used and login if needed" local token="" if [[ "${GITHUB_REGISTRY}" == "ghcr.io" ]]; then # For now ghcr.io can only authenticate using Personal Access Token with package access scope. @@ -484,7 +484,7 @@ function build_image::configure_github_docker_registry() { fi if [[ -z "${token}" ]] ; then verbosity::print_info - verbosity::print_info "Skip logging in to Github Registry. No Token available!" + verbosity::print_info "Skip logging in to GitHub Registry. No Token available!" verbosity::print_info fi if [[ -n "${token}" ]]; then @@ -653,7 +653,7 @@ function build_images::rebuild_ci_image_if_needed_and_confirmed() { fi } -# Retrieves Github Container Registry image prefix from repository name +# Retrieves GitHub Container Registry image prefix from repository name # GitHub Container Registry stores all images at the organization level, they are just # linked to the repository via docker label - however we assume a convention where we will # add repository name to organisation separated by '-' and convert everything to lowercase diff --git a/scripts/ci/libraries/_push_pull_remove_images.sh b/scripts/ci/libraries/_push_pull_remove_images.sh index 10c1503..aa6a264 100644 --- a/scripts/ci/libraries/_push_pull_remove_images.sh +++ b/scripts/ci/libraries/_push_pull_remove_images.sh @@ -297,7 +297,7 @@ function push_pull_remove_images::check_for_image_in_github_packages() { local image_to_wait_for=${GITHUB_REPOSITORY}/${image_name_in_github_registry}:${image_tag_in_github_registry} local github_api_call github_api_call="${github_api_endpoint}/${image_name_in_github_registry}/manifests/${image_tag_in_github_registry}" - echo "Github Packages: checking for ${image_to_wait_for} via ${github_api_call}!" + echo "GitHub Packages: checking for ${image_to_wait_for} via ${github_api_call}!" http_status=$(curl --silent --output "${OUTPUT_LOG}" --write-out "%{http_code}" \ --connect-timeout 60 --max-time 60 \ -X GET "${github_api_call}" -u "${GITHUB_USERNAME}:${GITHUB_TOKEN}") @@ -321,7 +321,7 @@ function push_pull_remove_images::check_for_image_in_github_container_registry() local image_tag_in_github_registry=${2} local image_to_wait_for="ghcr.io/${GITHUB_REPOSITORY}-${image_name_in_github_registry}:${image_tag_in_github_registry}" - echo "Github Container Registry: checking for ${image_to_wait_for} via docker manifest inspect!" + echo "GitHub Container Registry: checking for ${image_to_wait_for} via docker manifest inspect!" docker manifest inspect "${image_to_wait_for}" local res=$? if [[ ${res} == "0" ]]; then diff --git a/scripts/ci/libraries/_script_init.sh b/scripts/ci/libraries/_script_init.sh index c17a4a5..90e6404 100755 --- a/scripts/ci/libraries/_script_init.sh +++ b/scripts/ci/libraries/_script_init.sh @@ -53,7 +53,7 @@ initialization::make_constants_read_only start_end::group_end # Work around occasional unexplained failure on CI. Clear file flags on -# STDOUT (which is connected to a tmp file by Github Runner). +# STDOUT (which is connected to a tmp file by GitHub Runner). # The one error I did see: BlockingIOError: [Errno 11] write could not complete without blocking [[ "$CI" == "true" ]] && python3 -c "import fcntl; fcntl.fcntl(1, fcntl.F_SETFL, 0)" diff --git a/scripts/ci/libraries/_start_end.sh b/scripts/ci/libraries/_start_end.sh index 66bbc64..32ef4f4 100644 --- a/scripts/ci/libraries/_start_end.sh +++ b/scripts/ci/libraries/_start_end.sh @@ -16,7 +16,7 @@ # specific language governing permissions and limitations # under the License. -# Starts group for Github Actions - makes logs much more readable +# Starts group for GitHub Actions - makes logs much more readable function start_end::group_start { if [[ ${PRINT_INFO_FROM_SCRIPTS} != "false" ]]; then if [[ ${GITHUB_ACTIONS=} == "true" ]]; then @@ -29,7 +29,7 @@ function start_end::group_start { fi } -# Ends group for Github Actions +# Ends group for GitHub Actions function start_end::group_end { if [[ ${PRINT_INFO_FROM_SCRIPTS} != "false" ]]; then if [[ ${GITHUB_ACTIONS=} == "true" ]]; then diff --git a/scripts/in_container/_in_container_utils.sh b/scripts/in_container/_in_container_utils.sh index 1e9a192..836dd82 100644 --- a/scripts/in_container/_in_container_utils.sh +++ b/scripts/in_container/_in_container_utils.sh @@ -671,7 +671,7 @@ function get_providers_to_act_on() { group_end } -# Starts group for Github Actions - makes logs much more readable +# Starts group for GitHub Actions - makes logs much more readable function group_start { if [[ ${GITHUB_ACTIONS=} == "true" ]]; then echo "::group::${1}" @@ -682,7 +682,7 @@ function group_start { fi } -# Ends group for Github Actions +# Ends group for GitHub Actions function group_end { if [[ ${GITHUB_ACTIONS=} == "true" ]]; then echo -e "\033[0m" # Disable any colors set in the group diff --git a/scripts/in_container/check_environment.sh b/scripts/in_container/check_environment.sh index ec0fcf9..801477e 100755 --- a/scripts/in_container/check_environment.sh +++ b/scripts/in_container/check_environment.sh @@ -24,7 +24,7 @@ DISABLED_INTEGRATIONS="" # We want to avoid misleading messages and perform only forward lookup of the service IP address. # Netcat when run without -n performs both forward and reverse lookup and fails if the reverse # lookup name does not match the original name even if the host is reachable via IP. This happens -# randomly with docker-compose in Github Actions. +# randomly with docker-compose in GitHub Actions. # Since we are not using reverse lookup elsewhere, we can perform forward lookup in python # And use the IP in NC and add '-n' switch to disable any DNS use. # Even if this message might be harmless, it might hide the real reason for the problem diff --git a/scripts/in_container/prod/entrypoint_prod.sh b/scripts/in_container/prod/entrypoint_prod.sh index 1dab579..8d0d936 100755 --- a/scripts/in_container/prod/entrypoint_prod.sh +++ b/scripts/in_container/prod/entrypoint_prod.sh @@ -24,7 +24,7 @@ set -euo pipefail # We want to avoid misleading messages and perform only forward lookup of the service IP address. # Netcat when run without -n performs both forward and reverse lookup and fails if the reverse # lookup name does not match the original name even if the host is reachable via IP. This happens -# randomly with docker-compose in Github Actions. +# randomly with docker-compose in GitHub Actions. # Since we are not using reverse lookup elsewhere, we can perform forward lookup in python # And use the IP in NC and add '-n' switch to disable any DNS use. # Even if this message might be harmless, it might hide the real reason for the problem
