This is an automated email from the ASF dual-hosted git repository.
viirya 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 1621c713d Break out docs CI job to its own github action (#2151)
1621c713d is described below
commit 1621c713d724b0cd4aabccfa3243714789283df5
Author: Andrew Lamb <[email protected]>
AuthorDate: Sun Jul 24 14:52:16 2022 -0400
Break out docs CI job to its own github action (#2151)
* Break out docs CI job, trigger on rs changes
* fix
* fix
---
.github/workflows/docs.yml | 53 ++++++++++++++++++++++++++++++++++++++++++++++
.github/workflows/rust.yml | 31 ---------------------------
2 files changed, 53 insertions(+), 31 deletions(-)
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 000000000..3fc800f77
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,53 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+name: Docs
+
+on:
+ # always trigger
+ push:
+ pull_request:
+
+jobs:
+
+ # test doc links still work
+ docs:
+ name: Rustdocs are clean
+ runs-on: ubuntu-latest
+ strategy:
+ matrix:
+ arch: [ amd64 ]
+ rust: [ nightly ]
+ container:
+ image: ${{ matrix.arch }}/rust
+ env:
+ RUSTDOCFLAGS: "-Dwarnings"
+ steps:
+ - uses: actions/checkout@v2
+ with:
+ submodules: true
+ - name: Install python dev
+ run: |
+ apt update
+ apt install -y libpython3.9-dev
+ - name: Setup Rust toolchain
+ uses: ./.github/actions/setup-builder
+ with:
+ rust-version: ${{ matrix.rust }}
+ - name: Run cargo doc
+ run: |
+ cargo doc --document-private-items --no-deps --workspace
--all-features
diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
index b5223d59c..54a42b7a3 100644
--- a/.github/workflows/rust.yml
+++ b/.github/workflows/rust.yml
@@ -288,34 +288,3 @@ jobs:
cd arrow
cargo build --no-default-features --features=csv,ipc,simd --target
wasm32-unknown-unknown
cargo build --no-default-features --features=csv,ipc,simd --target
wasm32-wasi
-
- # test doc links still work
- docs:
- name: Docs are clean on AMD64 Rust ${{ matrix.rust }}
- runs-on: ubuntu-latest
- strategy:
- matrix:
- arch: [ amd64 ]
- rust: [ nightly ]
- container:
- image: ${{ matrix.arch }}/rust
- env:
- # Disable full debug symbol generation to speed up CI build and keep
memory down
- # "1" means line tables only, which is useful for panic tracebacks.
- RUSTFLAGS: "-C debuginfo=1"
- RUSTDOCFLAGS: "-Dwarnings"
- steps:
- - uses: actions/checkout@v2
- with:
- submodules: true
- - name: Install python dev
- run: |
- apt update
- apt install -y libpython3.9-dev
- - name: Setup Rust toolchain
- uses: ./.github/actions/setup-builder
- with:
- rust-version: ${{ matrix.rust }}
- - name: Run cargo doc
- run: |
- cargo doc --document-private-items --no-deps --workspace
--all-features
