Skip to content

[ci] Replace burnett01/rsync-deployments with local composite action#703

Merged
xintongsong merged 2 commits into
apache:mainfrom
GreatEugenius:hotfix-docs-build
May 25, 2026
Merged

[ci] Replace burnett01/rsync-deployments with local composite action#703
xintongsong merged 2 commits into
apache:mainfrom
GreatEugenius:hotfix-docs-build

Conversation

@GreatEugenius
Copy link
Copy Markdown
Collaborator

Purpose of change

The nightly Build Documentation workflow fails because burnett01/rsync-deployments is not in the ASF allowed-actions list. Replace it with a local composite action under .github/actions/rsync-deployments/, ported from apache/flink-kubernetes-operator#1035.

🔔 Note for committer

Please cherry-pick the first commit only (Add local rsync-deployments composite action) onto release-0.1 and release-0.2. The matrix job checks those branches out and resolves the local action from the workspace, so the action file must exist on each branch. The second commit (workflow change) is only needed on main — cron always reads the workflow from the default branch.

Tests

Verified on a personal fork: the local action loads and runs. It fails at ssh-add with error in libcrypto because the NIGHTLIES_RSYNC_KEY secret only exists in apache/flink-agents. Full verification needs a workflow_dispatch on the Apache repo after merge.

API

No

Documentation

  • doc-needed
  • doc-not-needed
  • doc-included

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.
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-actions github-actions Bot added doc-not-needed Your PR changes do not impact docs fixVersion/0.3.0 The feature or bug should be implemented/fixed in the 0.3.0 version. priority/major Default priority of the PR or issue. labels May 25, 2026
@GreatEugenius
Copy link
Copy Markdown
Collaborator Author

Hi, @xintongsong. Could you please review this PR? Thank you!

@GreatEugenius GreatEugenius requested a review from xintongsong May 25, 2026 02:29
Copy link
Copy Markdown
Contributor

@xintongsong xintongsong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Copy Markdown
Contributor

@xintongsong xintongsong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@xintongsong xintongsong merged commit dd30875 into apache:main May 25, 2026
50 of 51 checks passed
@xintongsong
Copy link
Copy Markdown
Contributor

Ported the first commit to:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc-not-needed Your PR changes do not impact docs fixVersion/0.3.0 The feature or bug should be implemented/fixed in the 0.3.0 version. priority/major Default priority of the PR or issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants