You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@arrow.apache.org by al...@apache.org on 2023/06/27 21:38:41 UTC
[arrow-rs] branch master updated: fix gh-pages deployment (#4452)
This is an automated email from the ASF dual-hosted git repository.
alamb pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/arrow-rs.git
The following commit(s) were added to refs/heads/master by this push:
new c8fb540a7 fix gh-pages deployment (#4452)
c8fb540a7 is described below
commit c8fb540a7c10c5fdc4e159a1549f14332287adcc
Author: xxchan <xx...@gmail.com>
AuthorDate: Tue Jun 27 23:38:35 2023 +0200
fix gh-pages deployment (#4452)
Mainly refered to opendal's setting https://github.com/apache/incubator-opendal/blob/7ede1bdc0849905a5b140cf984481adca05dc1b3/.github/workflows/docs.yml
---
.asf.yaml | 8 +++++++-
.github/workflows/docs.yml | 28 ++++++++++++++++++++--------
README.md | 2 +-
arrow/README.md | 2 +-
parquet/README.md | 2 +-
5 files changed, 30 insertions(+), 12 deletions(-)
diff --git a/.asf.yaml b/.asf.yaml
index 968c67792..9541db89d 100644
--- a/.asf.yaml
+++ b/.asf.yaml
@@ -38,4 +38,10 @@ github:
# require branches to be up-to-date before merging
strict: true
# don't require any jobs to pass
- contexts: []
\ No newline at end of file
+ contexts: []
+
+# publishes the content of the `asf-site` branch to
+# https://arrow.apache.org/rust/
+publish:
+ whoami: asf-site
+ subdir: rust
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index b46e6be3c..f94071fa9 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -66,6 +66,7 @@ jobs:
- name: Upload artifacts
uses: actions/upload-pages-artifact@v1
with:
+ name: crate-docs
path: target/doc
deploy:
@@ -73,13 +74,24 @@ jobs:
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/actions-gh-pages@v3.9.2
+ if: github.event_name == 'push' && github.ref_name == 'master'
+ with:
+ github_token: ${{ secrets.GITHUB_TOKEN }}
+ publish_dir: website/build
+ publish_branch: asf-site
diff --git a/README.md b/README.md
index 41cf9604a..53220620a 100644
--- a/README.md
+++ b/README.md
@@ -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
diff --git a/arrow/README.md b/arrow/README.md
index eef7db4d2..4d5206cba 100644
--- a/arrow/README.md
+++ b/arrow/README.md
@@ -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
diff --git a/parquet/README.md b/parquet/README.md
index bb2f96418..19f34fd87 100644
--- a/parquet/README.md
+++ b/parquet/README.md
@@ -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