kou commented on code in PR #553:
URL: https://github.com/apache/arrow-java/pull/553#discussion_r1926375367
##########
.github/workflows/rc.yml:
##########
@@ -412,6 +412,39 @@ jobs:
with:
name: release-docs
path: docs.tar.gz
+ docs:
+ name: Docs
+ needs:
+ - source
+ runs-on: ubuntu-latest
+ permissions:
+ contents: read
+ packages: write
+ steps:
+ - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b #
v5.3.0
+ with:
+ cache: 'pip'
+ - name: Download source archive
+ uses:
actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
+ with:
+ name: release-source
+ - name: Extract source archive
+ run: |
+ tar -xf apache-arrow-java-*.tar.gz --strip-components=1
+ - name: Build
+ run: |
+ cd docs
+ python -m venv venv
+ source venv/bin/activate
+ pip install -r requirements.txt
+ make html
+ - name: Compress into single artifact to keep directory structure
+ run: tar -cvzf docs.tar.gz -C docs/build html
+ - name: Upload artifacts
+ uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08
# v4.6.0
+ with:
+ name: release-sphinx-docs
+ path: docs.tar.gz
Review Comment:
Could you rename this to `sphinx-docs.tar.gz` or rename existing
`docs.tar.gz` to `api-docs.tar.gz`?
If we use duplicated names, we can't upload both of them to GitHub Releases.
Or how about combining them something like the following?
```diff
diff --git a/.github/workflows/rc.yml b/.github/workflows/rc.yml
index 821ad083..46afe8f3 100644
--- a/.github/workflows/rc.yml
+++ b/.github/workflows/rc.yml
@@ -399,9 +399,8 @@ jobs:
ci/scripts/jni_full_build.sh . jni binaries
- name: Prepare docs
run: |
- mkdir -p docs
- cp -a target/site/apidocs docs/reference
- tar -cvzf docs.tar.gz docs
+ cp -a target/site/apidocs reference
+ tar -cvzf reference.tar.gz reference
- name: Upload binaries
uses:
actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
with:
@@ -410,12 +409,12 @@ jobs:
- name: Upload docs
uses:
actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
with:
- name: release-docs
- path: docs.tar.gz
+ name: reference
+ path: reference.tar.gz
docs:
name: Docs
needs:
- - source
+ - binaries
runs-on: ubuntu-latest
permissions:
contents: read
@@ -427,7 +426,10 @@ jobs:
- name: Download source archive
uses:
actions/download-artifact@fa0a91b85d4f404e444e00e005971372dc801d16 # v4.1.8
with:
- name: release-source
+ name: |
+ release-source
+ reference
+ merge-multiple: true
- name: Extract source archive
run: |
tar -xf apache-arrow-java-*.tar.gz --strip-components=1
@@ -438,13 +440,14 @@ jobs:
source venv/bin/activate
pip install -r requirements.txt
make html
+ tar -xf ../reference.tar.gz -C docs/build/html
- name: Compress into single artifact to keep directory structure
- run: tar -cvzf docs.tar.gz -C docs/build html
+ run: tar -cvzf html.tar.gz -C docs/build html
- name: Upload artifacts
uses:
actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0
with:
- name: release-sphinx-docs
- path: docs.tar.gz
+ name: release-html
+ path: html.tar.gz
verify:
name: Verify
needs:
```
##########
docs/README.md:
##########
@@ -0,0 +1,28 @@
+<!---
+ 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.
+-->
+
+# Documentation
+
+Build with Sphinx.
+
+```
Review Comment:
```suggestion
```bash
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
