Skip to content

Commit

Permalink
fix gh-pages deployment (apache#4452)
Browse files Browse the repository at this point in the history
  • Loading branch information
xxchan authored Jun 27, 2023
1 parent c1656ff commit c8fb540
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 12 deletions.
8 changes: 7 additions & 1 deletion .asf.yaml
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/
publish:
whoami: asf-site
subdir: rust
28 changes: 20 additions & 8 deletions .github/workflows/docs.yml
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
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
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
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
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

0 comments on commit c8fb540

Please sign in to comment.