Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

GH-37858: [Docs][JS] Fix check of remote URL to generate JS docs #37870

Merged
merged 2 commits into from
Sep 26, 2023
Merged

GH-37858: [Docs][JS] Fix check of remote URL to generate JS docs #37870

merged 2 commits into from
Sep 26, 2023

Conversation

raulcd
Copy link
Member

@raulcd raulcd commented Sep 26, 2023 •
edited
Loading

Rationale for this change

JS Docs are currently not being generated.

What changes are included in this PR?

Use a regex check instead of an equality to cover both remote set with .git and without for upstream. Added also a fix to generate docs from origin from forks if necessary.

Are these changes tested?

Via archery

Are there any user-facing changes?

No

@github-actions
Copy link

⚠️ GitHub issue #37858 has been automatically assigned in GitHub to PR creator.

@raulcd
Copy link
Member Author

raulcd commented Sep 26, 2023

@github-actions crossbow submit preview-docs

@github-actions github-actions bot added the awaiting committer review Awaiting committer review label Sep 26, 2023
@github-actions
Copy link

Revision: 1b7b52a

Submitted crossbow builds: ursacomputing/crossbow @ actions-52a26733d4

Task Status
preview-docs Github Actions

@raulcd
Copy link
Member Author

raulcd commented Sep 26, 2023

@github-actions crossbow submit preview-docs

@github-actions
Copy link

Revision: e8ea90f

Submitted crossbow builds: ursacomputing/crossbow @ actions-6104c7ee44

Task Status
preview-docs Github Actions

@raulcd raulcd marked this pull request as ready for review September 26, 2023 12:21
@raulcd
Copy link
Member Author

raulcd commented Sep 26, 2023

It seems this never worked for PRs / preview docs, I did fix that and the fix should allow to fix the doc generation now. For the preview-docs it can be seen here: http://crossbow.voltrondata.com/pr_docs/37870/js/index.html

@raulcd raulcd requested a review from domoritz September 26, 2023 12:21
raulcd
raulcd commented Sep 26, 2023
View reviewed changes
ci/scripts/js_build.sh
yarn doc --gitRemote apache
elif [[ "$(git config --get remote.upstream.url)" =~ "https://github.com/apache/arrow" ]]; then
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this will work with both https://github.com/apache/arrow and https://github.com/apache/arrow.git

@github-actions github-actions bot added awaiting changes Awaiting changes and removed awaiting committer review Awaiting committer review labels Sep 26, 2023
@raulcd raulcd added awaiting committer review Awaiting committer review and removed awaiting changes Awaiting changes labels Sep 26, 2023
@domoritz
Copy link
Member

Awesome. Thanks for making the preview docs work as well!

@github-actions github-actions bot added awaiting merge Awaiting merge and removed awaiting committer review Awaiting committer review labels Sep 26, 2023
kou
kou approved these changes Sep 26, 2023
View reviewed changes
Copy link
Member

@kou kou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

+1

@kou kou merged commit 517d849 into apache:main Sep 26, 2023
19 checks passed
@kou kou removed the awaiting merge Awaiting merge label Sep 26, 2023
@github-actions github-actions bot added the awaiting merge Awaiting merge label Sep 26, 2023
@domoritz
Copy link
Member

Sweet. Thanks for the quick fix @raulcd. I guess you need to push the generated docs to the docs repo to update https://arrow.apache.org/docs/js/, right?

@raulcd
Copy link
Member Author

raulcd commented Sep 27, 2023

Sweet. Thanks for the quick fix @raulcd. I guess you need to push the generated docs to the docs repo to update https://arrow.apache.org/docs/js/, right?

Yes, I have to generate the docs from the 13.0.0 branch and create a PR to the arrow-site repo. I'm currently working on that.

@raulcd
Copy link
Member Author

raulcd commented Sep 27, 2023

The docs PR has been created there: apache/arrow-site#412

@conbench-apache-arrow
Copy link

After merging your PR, Conbench analyzed the 5 benchmarking runs that have been run so far on merge-commit 517d849.

There were no benchmark performance regressions. 🎉

The full Conbench report has more details. It also includes information about possible false positives for unstable benchmarks that are known to sometimes produce them.

etseidl pushed a commit to etseidl/arrow that referenced this pull request Sep 28, 2023
@raulcd @etseidl
apacheGH-37858: [Docs][JS] Fix check of remote URL to generate JS docs (
ed54324 
apache#37870)

### Rationale for this change

JS Docs are currently not being generated.

### What changes are included in this PR?

Use a regex check instead of an equality to cover both remote set with `.git` and without for upstream. Added also a fix to generate docs from origin from forks if necessary.

### Are these changes tested?

Via archery

### Are there any user-facing changes?
No
* Closes: apache#37858

Authored-by: Raúl Cumplido <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
JerAguilon pushed a commit to JerAguilon/arrow that referenced this pull request Oct 23, 2023
@raulcd
apacheGH-37858: [Docs][JS] Fix check of remote URL to generate JS docs (
bc13e0d 
apache#37870)

### Rationale for this change

JS Docs are currently not being generated.

### What changes are included in this PR?

Use a regex check instead of an equality to cover both remote set with `.git` and without for upstream. Added also a fix to generate docs from origin from forks if necessary.

### Are these changes tested?

Via archery

### Are there any user-facing changes?
No
* Closes: apache#37858

Authored-by: Raúl Cumplido <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
loicalleyne pushed a commit to loicalleyne/arrow that referenced this pull request Nov 13, 2023
@raulcd @loicalleyne
apacheGH-37858: [Docs][JS] Fix check of remote URL to generate JS docs (
e88aca5 
apache#37870)

### Rationale for this change

JS Docs are currently not being generated.

### What changes are included in this PR?

Use a regex check instead of an equality to cover both remote set with `.git` and without for upstream. Added also a fix to generate docs from origin from forks if necessary.

### Are these changes tested?

Via archery

### Are there any user-facing changes?
No
* Closes: apache#37858

Authored-by: Raúl Cumplido <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
dgreiss pushed a commit to dgreiss/arrow that referenced this pull request Feb 19, 2024
@raulcd @dgreiss
apacheGH-37858: [Docs][JS] Fix check of remote URL to generate JS docs (
336ea3f 
apache#37870)

### Rationale for this change

JS Docs are currently not being generated.

### What changes are included in this PR?

Use a regex check instead of an equality to cover both remote set with `.git` and without for upstream. Added also a fix to generate docs from origin from forks if necessary.

### Are these changes tested?

Via archery

### Are there any user-facing changes?
No
* Closes: apache#37858

Authored-by: Raúl Cumplido <[email protected]>
Signed-off-by: Sutou Kouhei <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@domoritz domoritz domoritz approved these changes

@kou kou kou approved these changes

@assignUser assignUser Awaiting requested review from assignUser assignUser is a code owner

Assignees
No one assigned
Labels
awaiting merge Awaiting merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Docs][Website] JS docs are missing
3 participants
@raulcd @domoritz @kou