Skip to content
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

Merged
merged 1 commit into from
Jun 27, 2023
Merged

fix docs deployment #4452

merged 1 commit into from
Jun 27, 2023

Conversation

xxchan
Copy link
Contributor

@xxchan xxchan commented Jun 26, 2023

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?

@github-actions github-actions bot added arrow Changes to the arrow crate parquet Changes to the parquet crate labels Jun 26, 2023

# publishes the content of the `asf-site` branch to
# https://arrow.apache.org/rust/
Copy link
Contributor Author

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

@xxchan
Copy link
Contributor Author

xxchan commented Jun 26, 2023

@alamb PTAL

Copy link
Contributor

@alamb alamb left a 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) 🤔

https://github.com/apache/arrow-julia/blob/f8d2203b07380e1423723b5bfe32356aa1239284/.github/workflows/ci.yml#L152-L153

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
Copy link
Contributor

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?

https://github.com/apache/arrow-datafusion/blob/1d7cfe2256f6416afbd12b04af5b095b23b78c5d/.github/workflows/docs.yaml#L45-L64

Copy link
Contributor Author

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

Copy link
Contributor

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

How did you find out it was an approved action?

I didn't find a definitive list neither, but OpenDAL uses it so it should imply so. 🤣

Also mentioned in the link above

image

Copy link
Contributor

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 🚀

@alamb alamb merged commit c8fb540 into apache:master Jun 27, 2023
@alamb
Copy link
Contributor

alamb commented Jun 28, 2023

BTW it appears to be working well: https://arrow.apache.org/rust/

Screenshot 2023-06-28 at 3 33 44 PM

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

@alamb
Copy link
Contributor

alamb commented Jun 28, 2023

Proposed follow on : #4461

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
arrow Changes to the arrow crate parquet Changes to the parquet crate
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants