-
Notifications
You must be signed in to change notification settings - Fork 875
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix docs deployment #4452
fix docs deployment #4452
Conversation
|
||
# publishes the content of the `asf-site` branch to | ||
# https://arrow.apache.org/rust/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's https://arrow.apache.org/julia/ , so I used /rust
@alamb PTAL |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @xxchan -- this is looking great
My only question is about using the third-party github action.
However, when looking at arrow-julia I see it uses a third party action as well (julia-actions
) 🤔
tar -xf website/build/artifact.tar -C website/build | ||
rm website/build/artifact.tar | ||
cp .asf.yaml ./website/build/.asf.yaml | ||
- name: Deploy to gh-pages |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we try to avoid using third-party github actions, as they can potentially be an attack vector.
I wonder what you think about using git
directly like this?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IIUC ASF projects can only run whitelisted actions and this is an approved action, so it should be fine.
https://issues.apache.org/jira/browse/INFRA-21676?jql=text%20~%20%22peaceiris%2Factions-gh-pages%22
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
IIUC ASF projects can only run whitelisted actions and
Yes this is my understanding too
this is an approved action, so it should be fine.
How did you find out it was an approved action? I couldn't seem to find a definitive list
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't find a definitive list neither, but OpenDAL uses it so it should imply so. 🤣
Makes sense thanks @xxchan 🚀
BTW it appears to be working well: https://arrow.apache.org/rust/ However, I think the main docs page should probably still point at the crate.io page for the released version. I will make a PR for that |
Proposed follow on : #4461 |
Fixup #4436
Mainly refered to opendal's action https://github.com/apache/incubator-opendal/blob/7ede1bdc0849905a5b140cf984481adca05dc1b3/.github/workflows/docs.yml
Tested on my fork https://github.com/xxchan/arrow-rs/tree/asf-site (the
asf-site
branch might need to be manually created first). Not 100% sure the url works correctly though.Rationale for this change
What changes are included in this PR?
Are there any user-facing changes?