From d5bc1ffffb81fa64dbb14069ff482a97272eeeec Mon Sep 17 00:00:00 2001 From: youjin Date: Mon, 25 May 2026 10:06:43 +0800 Subject: [PATCH 1/2] [ci] Add local rsync-deployments composite action Add a local composite action under .github/actions/rsync-deployments that wraps rsync-over-SSH for documentation deployment. Ported from apache/flink-kubernetes-operator#1035 with MIT attribution preserved. This action is intended to replace the third-party burnett01/rsync-deployments action, which is not in the ASF allowed-actions list. Locally-defined actions are not subject to that allow-list, so they can be used safely in ASF repositories. This commit is purely additive (no existing files modified) and can be cherry-picked cleanly to release branches so the nightly docs matrix job can resolve the local action when checking out those branches. --- .github/actions/rsync-deployments/LICENSE | 26 ++++++++ .github/actions/rsync-deployments/action.yml | 66 ++++++++++++++++++++ 2 files changed, 92 insertions(+) create mode 100644 .github/actions/rsync-deployments/LICENSE create mode 100644 .github/actions/rsync-deployments/action.yml diff --git a/.github/actions/rsync-deployments/LICENSE b/.github/actions/rsync-deployments/LICENSE new file mode 100644 index 000000000..f199b8016 --- /dev/null +++ b/.github/actions/rsync-deployments/LICENSE @@ -0,0 +1,26 @@ +The local composite action at .github/actions/rsync-deployments/action.yml +was inspired by the rsync-deployments GitHub Action, which is distributed +under the MIT License reproduced below. + +MIT License + +Copyright (c) 2019-2022 Contention +Copyright (c) 2019-2025 Burnett01 + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/.github/actions/rsync-deployments/action.yml b/.github/actions/rsync-deployments/action.yml new file mode 100644 index 000000000..4ac771bdb --- /dev/null +++ b/.github/actions/rsync-deployments/action.yml @@ -0,0 +1,66 @@ +# 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. + +# This implementation took inspiration from https://github.com/Burnett01/rsync-deployments/blob/7.1.0/action.yml +name: Rsync Deploy (local) +description: Upload a folder to a single remote destination via rsync over SSH. +inputs: + switches: + description: rsync switches + required: false + default: "--archive --compress" + path: + description: Local source directory + required: true + remote_path: + description: Remote destination directory + required: true + remote_host: + description: SSH host + required: true + remote_port: + description: SSH port + required: false + default: "22" + remote_user: + description: SSH username + required: true + remote_key: + description: SSH private key (OpenSSH/PEM) + required: true +runs: + using: composite + steps: + - name: rsync via ssh-agent + shell: bash + run: | + set -euo pipefail + + # Start agent and load the key + eval "$(ssh-agent -s)" + ssh-add - <<< "${{ inputs.remote_key }}" + + # SSH command with host key checking disabled (matches your reference impl) + RSH="ssh -o StrictHostKeyChecking=no -p ${{ inputs.remote_port }}" + + # Resolve paths and DSN + LOCAL_PATH="$GITHUB_WORKSPACE/${{ inputs.path }}" + DSN="${{ inputs.remote_user }}@${{ inputs.remote_host }}" + + # Deploy + sh -c "rsync ${{ inputs.switches }} -e '$RSH' $LOCAL_PATH $DSN:${{ inputs.remote_path }}" + + # Cleanup identities from the agent + ssh-add -D || true From 9799a8f09bcea017b9ce2c823dc543b27b46e14f Mon Sep 17 00:00:00 2001 From: youjin Date: Mon, 25 May 2026 10:06:59 +0800 Subject: [PATCH 2/2] [ci] Use local rsync-deployments action in docs workflow Switch the two upload steps in .github/workflows/docs.yml from burnett01/rsync-deployments to the locally-defined action added in the previous commit. This fixes the nightly docs build, which currently fails because the third-party action is not in the ASF allowed-actions list. This commit only touches main's workflow file. The cron trigger always reads the workflow definition from the default branch, so release branches do not need this change for the scheduled build to work -- they only need the local action committed alongside. --- .github/workflows/docs.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index e7437a4f5..4b83e4f26 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -56,7 +56,7 @@ jobs: docker run --rm --volume "$PWD:/root/flink-agents" chesnay/flink-ci:java_8_11_17_21_maven_386 bash -c "cd /root/flink-agents && chmod +x ./tools/docs.sh && ./tools/docs.sh" - name: Upload documentation - uses: burnett01/rsync-deployments@7659d600d8bdd035bb5cdfba1d4bd0dd4a307ca6 # 8.0.2 + uses: ./.github/actions/rsync-deployments with: switches: --archive --compress --delete path: docs/target/ @@ -68,7 +68,7 @@ jobs: - name: Upload documentation alias if: env.flink_alias != '' - uses: burnett01/rsync-deployments@7659d600d8bdd035bb5cdfba1d4bd0dd4a307ca6 # 8.0.2 + uses: ./.github/actions/rsync-deployments with: switches: --archive --compress --delete path: docs/target/