Skip to content

fix docs deployment #4452

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.

Sign up for GitHub

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

Merged
alamb merged 1 commit into from
Jun 27, 2023
Merged

fix docs deployment #4452

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion .asf.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,4 +38,10 @@ github:
# require branches to be up-to-date before merging
strict: true
# don't require any jobs to pass
contexts: []
contexts: []

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

@xxchan xxchan Jun 26, 2023

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

publish:
whoami: asf-site
subdir: rust
28 changes: 20 additions & 8 deletions .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,20 +66,32 @@ jobs:
- name: Upload artifacts
uses: actions/upload-pages-artifact@v1
with:
name: crate-docs
path: target/doc

deploy:
# Only deploy if a push to master
if: github.ref_name == 'master' && github.event_name == 'push'
needs: docs
permissions:
pages: write # to deploy to Pages
id-token: write # to verify the deployment originates from an appropriate source
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
contents: write
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
- uses: actions/checkout@v3
- name: Download crate docs
uses: actions/download-artifact@v3
with:
name: crate-docs
path: website/build
- name: Prepare website
run: |
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

@alamb alamb Jun 27, 2023

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
Member Author

@xxchan xxchan Jun 27, 2023

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

@alamb alamb Jun 27, 2023

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
Member Author

@xxchan xxchan Jun 27, 2023

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

@alamb alamb Jun 27, 2023

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 🚀

uses: peaceiris/[email protected]
if: github.event_name == 'push' && github.ref_name == 'master'
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: website/build
publish_branch: asf-site
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This repo contains the following main components:
| arrow-flight | Support for Arrow-Flight IPC protocol | [(README)][flight-readme] |
| object-store | Support for object store interactions (aws, azure, gcp, local, in-memory) | [(README)][objectstore-readme] |

See the list of all crates in this repo and their rustdocs [here](https://apache.github.io/arrow-rs).
See the list of all crates in this repo and their rustdocs [here](https://arrow.apache.org/rust).

There are two related crates in a different repository

Expand Down
2 changes: 1 addition & 1 deletion arrow/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

This crate contains the official Native Rust implementation of [Apache Arrow][arrow] in memory format, governed by the Apache Software Foundation.

The [crate documentation](https://apache.github.io/arrow-rs/arrow/index.html) contains examples and full API.
The [crate documentation](https://arrow.apache.org/rust/arrow/index.html) contains examples and full API.
There are several [examples](https://github.com/apache/arrow-rs/tree/master/arrow/examples) to start from as well.

## Rust Version Compatibility
Expand Down
2 changes: 1 addition & 1 deletion parquet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@

This crate contains the official Native Rust implementation of [Apache Parquet](https://parquet.apache.org/), which is part of the [Apache Arrow](https://arrow.apache.org/) project.

See [crate documentation](https://apache.github.io/arrow-rs/parquet/index.html) for examples and the full API.
See [crate documentation](https://arrow.apache.org/rust/parquet/index.html) for examples and the full API.

## Rust Version Compatibility

Expand Down