Build documentation #432
This file contains 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: "Build documentation" | |
| on: | |
| pull_request: | |
| branches: | |
| - master | |
| - release-* | |
| paths: | |
| - 'docs/**' | |
| schedule: | |
| - cron: '0 0 * * *' # Deploy every day | |
| workflow_dispatch: | |
| concurrency: | |
| group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event.number || github.run_id }} | |
| cancel-in-progress: true | |
| jobs: | |
| check-doc: | |
| if: github.repository == 'apache/flink-cdc' | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| - name: Check dead links | |
| uses: gaurav-nelson/[email protected] | |
| with: | |
| config-file: '.dlc.json' | |
| - name: Build doc | |
| run: | | |
| docker run --rm --volume "$PWD:/root/flink-cdc" chesnay/flink-ci:java_8_11_17_21_maven_386 bash -c "cd /root/flink-cdc && chmod +x ./.github/workflows/docs.sh && ./.github/workflows/docs.sh" | |
| build-documentation: | |
| if: github.event_name != 'pull_request' && github.repository == 'apache/flink-cdc' | |
| name: "Check and build doc" | |
| runs-on: ubuntu-latest | |
| strategy: | |
| fail-fast: false | |
| max-parallel: 1 | |
| matrix: | |
| branch: | |
| - master | |
| - release-3.2 | |
| - release-3.1 | |
| steps: | |
| - uses: actions/checkout@v3 | |
| with: | |
| ref: ${{ matrix.branch }} | |
| - name: Set branch environment variable | |
| run: | | |
| currentBranch=$(git branch --show-current) | |
| echo "flink_branch=${currentBranch}" >> ${GITHUB_ENV} | |
| if [ "${currentBranch}" = "master" ]; then | |
| echo "flink_alias=release-3.3" >> ${GITHUB_ENV} | |
| elif [ "${currentBranch}" = "release-3.2" ]; then | |
| echo "flink_alias=stable" >> ${GITHUB_ENV} | |
| fi | |
| - name: Check dead links | |
| uses: gaurav-nelson/[email protected] | |
| with: | |
| config-file: '.dlc.json' | |
| - name: Build documentation | |
| run: | | |
| docker run --rm --volume "$PWD:/root/flink-cdc" chesnay/flink-ci:java_8_11_17_21_maven_386 bash -c "cd /root/flink-cdc && chmod +x ./.github/workflows/docs.sh && ./.github/workflows/docs.sh" | |
| - name: Upload documentation | |
| uses: burnett01/[email protected] | |
| with: | |
| switches: --archive --compress --delete | |
| path: docs/target/ | |
| remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH }}/flink/flink-cdc-docs-${{ env.flink_branch }}/ | |
| remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }} | |
| remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }} | |
| remote_user: ${{ secrets.NIGHTLIES_RSYNC_USER }} | |
| remote_key: ${{ secrets.NIGHTLIES_RSYNC_KEY }} | |
| - name: Upload documentation alias | |
| if: env.flink_alias != '' | |
| uses: burnett01/[email protected] | |
| with: | |
| switches: --archive --compress --delete | |
| path: docs/target/ | |
| remote_path: ${{ secrets.NIGHTLIES_RSYNC_PATH }}/flink/flink-cdc-docs-${{ env.flink_alias }}/ | |
| remote_host: ${{ secrets.NIGHTLIES_RSYNC_HOST }} | |
| remote_port: ${{ secrets.NIGHTLIES_RSYNC_PORT }} | |
| remote_user: ${{ secrets.NIGHTLIES_RSYNC_USER }} | |
| remote_key: ${{ secrets.NIGHTLIES_RSYNC_KEY }} |