Publish Docs to S3 #83
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # 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. | |
| # | |
| --- | |
| name: Publish Docs to S3 | |
| on: # yamllint disable-line rule:truthy | |
| workflow_dispatch: | |
| inputs: | |
| ref: | |
| description: "The branch or tag to checkout for the docs publishing" | |
| required: true | |
| type: string | |
| destination: | |
| description: "The destination location in S3" | |
| required: false | |
| default: auto | |
| type: choice | |
| options: | |
| - auto | |
| - live | |
| - staging | |
| include-docs: | |
| description: "Space separated list of packages to build" | |
| required: true | |
| type: string | |
| exclude-docs: | |
| description: "Comma separated list of docs to exclude" | |
| required: false | |
| default: "no-docs-excluded" | |
| type: string | |
| skip-write-to-stable-folder: | |
| description: "Do not override stable version" | |
| required: false | |
| default: false | |
| type: boolean | |
| permissions: | |
| contents: read | |
| jobs: | |
| build-info: | |
| timeout-minutes: 10 | |
| name: "Build Info" | |
| runs-on: ["ubuntu-24.04"] | |
| env: | |
| GITHUB_CONTEXT: ${{ toJson(github) }} | |
| VERBOSE: true | |
| REF: ${{ inputs.ref }} | |
| INCLUDE_DOCS: ${{ inputs.include-docs }} | |
| EXCLUDE_DOCS: ${{ inputs.exclude-docs }} | |
| DESTINATION: ${{ inputs.destination }} | |
| SKIP_WRITE_TO_STABLE_FOLDER: ${{ inputs.skip-write-to-stable-folder }} | |
| outputs: | |
| include-docs: ${{ inputs.include-docs == 'all' && '' || inputs.include-docs }} | |
| destination-location: ${{ steps.parameters.outputs.destination-location }} | |
| destination: ${{ steps.parameters.outputs.destination }} | |
| extra-build-options: ${{ steps.parameters.outputs.extra-build-options }} | |
| # yamllint disable rule:line-length | |
| skip-write-to-stable-folder: ${{ inputs.skip-write-to-stable-folder && '--skip-write-to-stable-folder' || '' }} | |
| if: contains(fromJSON('[ | |
| "ashb", | |
| "eladkal", | |
| "ephraimbuddy", | |
| "jedcunningham", | |
| "kaxil", | |
| "pierrejeambrun", | |
| "potiuk", | |
| "utkarsharma2" | |
| ]'), github.event.sender.login) | |
| steps: | |
| - name: "Input parameters summary" | |
| shell: bash | |
| id: parameters | |
| run: | | |
| echo "Input parameters summary" | |
| echo "=========================" | |
| echo "Ref: '${REF}'" | |
| echo "Included docs : '${INCLUDE_DOCS}'" | |
| echo "Exclude docs: '${EXCLUDE_DOCS}'" | |
| echo "Destination: '${DESTINATION}'" | |
| echo "Skip write to stable folder: '${SKIP_WRITE_TO_STABLE_FOLDER}'" | |
| if [[ "${DESTINATION}" == "auto" ]]; then | |
| if [[ "${REF}" =~ ^.*[0-9]*\.[0-9]*\.[0-9]*$ ]]; then | |
| echo "${REF} looks like final release, using live destination" | |
| DESTINATION="live" | |
| else | |
| echo "${REF} does not looks like final release, using staging destination" | |
| DESTINATION="staging" | |
| fi | |
| fi | |
| echo "destination=${DESTINATION}" >> ${GITHUB_OUTPUT} | |
| if [[ "${DESTINATION}" == "live" ]]; then | |
| echo "destination-location=s3://live-docs-airflow-apache-org/docs/" >> ${GITHUB_OUTPUT} | |
| else | |
| echo "destination-location=s3://staging-docs-airflow-apache-org/docs/" >> ${GITHUB_OUTPUT} | |
| fi | |
| build-docs: | |
| needs: [build-info] | |
| timeout-minutes: 150 | |
| name: "Build documentation" | |
| runs-on: ubuntu-latest | |
| env: | |
| GITHUB_REPOSITORY: ${{ github.repository }} | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GITHUB_USERNAME: ${{ github.actor }} | |
| INCLUDE_SUCCESS_OUTPUTS: false | |
| PYTHON_MAJOR_MINOR_VERSION: 3.9 | |
| VERBOSE: "true" | |
| EXTRA_BUILD_OPTIONS: ${{ needs.build-info.outputs.extra-build-options }} | |
| steps: | |
| - name: "Cleanup repo" | |
| shell: bash | |
| run: docker run -v "${GITHUB_WORKSPACE}:/workspace" -u 0:0 bash -c "rm -rf /workspace/*" | |
| # Check out the repo first to run cleanup - in sub-folder | |
| - name: "Checkout current version first to clean-up stuff" | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| persist-credentials: false | |
| path: current-version | |
| - name: "Prepare and cleanup runner" | |
| run: ./scripts/ci/prepare_and_cleanup_runner.sh | |
| working-directory: current-version | |
| # We are checking repo for both - breeze and docs from the ref provided as input | |
| # This will take longer as we need to rebuild CI image and it will not use cache | |
| # but it will build the CI image from the version of Airflow that is used to check out things | |
| - name: "Checkout ${{ inputs.ref }} " | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| persist-credentials: false | |
| ref: ${{ inputs.ref }} | |
| fetch-depth: 0 | |
| fetch-tags: true | |
| - name: "Install Breeze" | |
| uses: ./.github/actions/breeze | |
| with: | |
| use-uv: ${{ inputs.use-uv }} | |
| - name: "Building docs with --docs-only flag" | |
| env: | |
| INCLUDE_DOCS: ${{ needs.build-info.outputs.include-docs }} | |
| INCLUDE_COMMITS: "true" | |
| run: > | |
| breeze build-docs ${INCLUDE_DOCS} --docs-only | |
| - name: Check disk space available | |
| run: df -H | |
| # Here we will create temp airflow-site dir to publish docs | |
| - name: Create /mnt/airflow-site directory | |
| run: | | |
| sudo mkdir -p /mnt/airflow-site && sudo chown -R "${USER}" /mnt/airflow-site | |
| echo "AIRFLOW_SITE_DIRECTORY=/mnt/airflow-site/" >> "$GITHUB_ENV" | |
| - name: "Publish docs to /mnt/airflow-site directory" | |
| env: | |
| INCLUDE_DOCS: ${{ needs.build-info.outputs.include-docs }} | |
| run: > | |
| breeze release-management publish-docs --override-versioned --run-in-parallel ${INCLUDE_DOCS} | |
| - name: "Upload build docs" | |
| uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2 | |
| with: | |
| name: airflow-docs | |
| path: /mnt/airflow-site | |
| retention-days: '7' | |
| if-no-files-found: 'error' | |
| overwrite: 'true' | |
| publish-docs-to-s3: | |
| needs: [build-docs, build-info] | |
| name: "Publish documentation to S3" | |
| permissions: | |
| id-token: write | |
| contents: read | |
| runs-on: ubuntu-latest | |
| env: | |
| GITHUB_REPOSITORY: ${{ github.repository }} | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| GITHUB_USERNAME: ${{ github.actor }} | |
| INCLUDE_SUCCESS_OUTPUTS: false | |
| PYTHON_MAJOR_MINOR_VERSION: 3.9 | |
| VERBOSE: "true" | |
| steps: | |
| - name: "Cleanup repo" | |
| shell: bash | |
| run: docker run -v "${GITHUB_WORKSPACE}:/workspace" -u 0:0 bash -c "rm -rf /workspace/*" | |
| # We are checking repo for both - breeze and docs from the "workflow' branch | |
| # This will take longer as we need to rebuild CI image and it will not use cache | |
| # but it will build the CI image from the version of Airflow that is used to check out things | |
| - name: "Checkout ${{ inputs.ref }} " | |
| uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2 | |
| with: | |
| persist-credentials: false | |
| - name: "Prepare and cleanup runner" | |
| run: ./scripts/ci/prepare_and_cleanup_runner.sh | |
| - name: "Install Breeze" | |
| uses: ./.github/actions/breeze | |
| with: | |
| use-uv: ${{ inputs.use-uv }} | |
| - name: "Download docs prepared as artifacts" | |
| uses: actions/download-artifact@d3f86a106a0bac45b974a628896c90dbdf5c8093 # v4.3.0 | |
| with: | |
| name: airflow-docs | |
| path: /mnt/airflow-site | |
| - name: Check disk space available | |
| run: df -H | |
| - name: "Update watermarks" | |
| env: | |
| SOURCE_DIR_PATH: "/mnt/airflow-site/docs-archive/" | |
| # yamllint disable rule:line-length | |
| run: | | |
| curl -sSf -o add_watermark.py https://raw.githubusercontent.com/apache/airflow-site/refs/heads/main/.github/scripts/add_watermark.py \ | |
| --header "Authorization: Bearer ${{ github.token }} " --header "X-GitHub-Api-Version: 2022-11-28" | |
| chmod a+x add_watermark.py | |
| mkdir -p images | |
| curl -sSf -o images/staging.png https://raw.githubusercontent.com/apache/airflow-site/refs/heads/main/.github/scripts/images/staging.png | |
| uv run add_watermark.py --pattern 'main.min*css' --folder ${SOURCE_DIR_PATH} \ | |
| --image-directory images --url-prefix /images | |
| if: needs.build-info.outputs.destination == 'staging' | |
| - name: Install AWS CLI v2 | |
| run: | | |
| curl "https://awscli.amazonaws.com/awscli-exe-linux-x86_64.zip" -o /tmp/awscliv2.zip | |
| unzip -q /tmp/awscliv2.zip -d /tmp | |
| rm /tmp/awscliv2.zip | |
| sudo /tmp/aws/install --update | |
| rm -rf /tmp/aws/ | |
| - name: Configure AWS credentials | |
| uses: aws-actions/configure-aws-credentials@010d0da01d0b5a38af31e9c3470dbfdabdecca3a # v4.0.1 | |
| with: | |
| aws-access-key-id: ${{ secrets.DOCS_AWS_ACCESS_KEY_ID }} | |
| aws-secret-access-key: ${{ secrets.DOCS_AWS_SECRET_ACCESS_KEY }} | |
| aws-region: us-east-2 | |
| - name: "Syncing docs to S3" | |
| env: | |
| DESTINATION_LOCATION: "${{ needs.build-info.outputs.destination-location }}" | |
| SOURCE_DIR_PATH: "/mnt/airflow-site/docs-archive/" | |
| EXCLUDE_DOCS: "${{ inputs.exclude-docs }}" | |
| SKIP_WRITE_TO_STABLE_FOLDER: "${{ needs.build-info.outputs.skip-write-to-stable-folder }}" | |
| run: | | |
| breeze release-management publish-docs-to-s3 --source-dir-path ${SOURCE_DIR_PATH} \ | |
| --destination-location ${DESTINATION_LOCATION} --stable-versions \ | |
| --exclude-docs ${EXCLUDE_DOCS} --overwrite ${SKIP_WRITE_TO_STABLE_FOLDER} |