Merged
Conversation
Member
Author
|
This doesn't combine the Javadocs and Sphinx docs. I'd like to extract the plugin from arrow-adbc (that lets you reference Javadocs via Intersphinx) for that purpose eventually. |
058659d to
0207fc9
Compare
kou
reviewed
Jan 23, 2025
.github/workflows/rc.yml
Outdated
| uses: actions/upload-artifact@65c4c4a1ddee5b72f698fdd19549f0f0fb45cf08 # v4.6.0 | ||
| with: | ||
| name: release-sphinx-docs | ||
| path: docs.tar.gz |
Member
There was a problem hiding this 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 --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:Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
kou
reviewed
Jan 23, 2025
Co-authored-by: Sutou Kouhei <kou@cozmixng.org>
kou
approved these changes
Jan 24, 2025
Member
kou
left a comment
There was a problem hiding this comment.
+1
I confirmed that release-html asset has expected HTML.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #546.