Skip to content

[FLINK-38448] Rework doc build and doc deployment#1035

Merged
ferenc-csaky merged 5 commits into
apache:mainfrom
ferenc-csaky:FLINK-38448
Sep 29, 2025
Merged

[FLINK-38448] Rework doc build and doc deployment#1035
ferenc-csaky merged 5 commits into
apache:mainfrom
ferenc-csaky:FLINK-38448

Conversation

@ferenc-csaky

Copy link
Copy Markdown
Contributor

No description provided.

@ferenc-csaky ferenc-csaky requested a review from gyfora September 27, 2025 18:40

@gyfora gyfora left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Can you please add a minimal context on why this change is required and where the new action.yml is coming from?

@ferenc-csaky

Copy link
Copy Markdown
Contributor Author

Context added to the Jira ticket. And the action.yml comes from me and ChatGPT :)

@gyfora

gyfora commented Sep 28, 2025

Copy link
Copy Markdown
Contributor

How about we simply copy the appropriate action from the burnett01/rsync-deployments codebase: https://github.com/Burnett01/rsync-deployments/tree/7.1.0

We could copy the logic as is, and add the MIT license in: LICENSE.rsync-deployments

@ferenc-csaky

Copy link
Copy Markdown
Contributor Author

How about we simply copy the appropriate action from the burnett01/rsync-deployments codebase: https://github.com/Burnett01/rsync-deployments/tree/7.1.0

We could copy the logic as is, and add the MIT license in: LICENSE.rsync-deployments

That action runs in a Docker img. So we need to copy over pretty much the whole codebase (action.yml, Dockerfile, entrypoint.sh). It has the benefit of a fixed rsync version, I'm 99% sure it won't matter at all. I'm okay to do that though, just let me know if that would be preferred.

@ferenc-csaky

Copy link
Copy Markdown
Contributor Author

Or as an alternative we could copy entrypoint.sh and slightly modify the action.yml to call it directly, excluding the Docker portion.

@gyfora

gyfora commented Sep 29, 2025

Copy link
Copy Markdown
Contributor

I was just looking at the current code and comparing with the entry point.sh/action.yml. It already looks very very similar .
We can reorganize/modify it, as long as we at least include the reference / notice its clean and clear where it's coming from

@ferenc-csaky ferenc-csaky merged commit 3e3cb58 into apache:main Sep 29, 2025
118 checks passed
@ferenc-csaky ferenc-csaky changed the title [FLINK-38448] Replace burnett01/rsync-deployments with a custom rsync-deploy action in docs.yaml [FLINK-38448] Rework doc build and doc deployment Sep 29, 2025
GreatEugenius added a commit to GreatEugenius/flink-agents that referenced this pull request May 25, 2026
The third-party burnett01/rsync-deployments action is not in the ASF
allowed-actions list, causing the nightly docs workflow to fail. Replace
it with a local composite action under .github/actions/rsync-deployments
(ported from apache/flink-kubernetes-operator#1035), since locally-defined
actions are not subject to the third-party allow-list.
GreatEugenius added a commit to GreatEugenius/flink-agents that referenced this pull request May 25, 2026
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.
GreatEugenius added a commit to GreatEugenius/flink-agents that referenced this pull request May 25, 2026
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.
xintongsong pushed a commit to apache/flink-agents that referenced this pull request May 25, 2026
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.
xintongsong pushed a commit to apache/flink-agents that referenced this pull request May 25, 2026
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.
xintongsong pushed a commit to apache/flink-agents that referenced this pull request May 25, 2026
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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants