Skip to content

ARROW-14505: [CI][Docs] Exercise documentation builds more frequently - #11567

Closed
kszucs wants to merge 24 commits into
apache:masterfrom
kszucs:build-docs-on-main-branch
Closed

ARROW-14505: [CI][Docs] Exercise documentation builds more frequently#11567
kszucs wants to merge 24 commits into
apache:masterfrom
kszucs:build-docs-on-main-branch

Conversation

@kszucs

Copy link
Copy Markdown
Member

No description provided.

@kszucskszucs changed the title [CI][Docs] Exercise documentation builds on the main branchARROW-14505: [CI][Docs] Exercise documentation builds on the main branchOct 28, 2021
@github-actions

Copy link
Copy Markdown

@github-actions

Copy link
Copy Markdown

⚠️ Ticket has not been started in JIRA, please click 'Start Progress'.

Comment thread.github/workflows/docs.yml Outdated
Comment on lines 23 to 34

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Does this mean the workflow only runs on PRs if any of those scripts is edited?

(this is not meant to catch build errors due to changes in the actual docs?)

@kszucskszucsOct 28, 2021

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

This build will test the complete documentation build only on master and other implementation/binding dependent builds are going to be responsible to test the relevant sections triggered on all PR updates:

  • conda-cpp: exercise doxygen
  • conda-python: exercise sphinx
  • debian-js: exercise js docs
  • ubuntu-r: exercise R docs

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

It sounds less fragile to just add the ci directory here.

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

The ubuntu-docs build is too expensive so it's better to restrict for PRs.

It will be executed for all commits on master though.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Do we get any notification when CI runs fail on master?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Good question, even if we would get GHA notifications I assume most of us have filtered those emails out.

We can always inspect the build statuses from https://github.com/apache/arrow/commits/master which helps to identify the breaking commit.

@kszucskszucs changed the title ARROW-14505: [CI][Docs] Exercise documentation builds on the main branchARROW-14505: [CI][Docs] Exercise documentation builds more frequentlyOct 28, 2021
@apacheapache deleted a comment from github-actionsBotOct 28, 2021
Comment threaddocker-compose.yml Outdated
Comment threaddocker-compose.yml Outdated
Comment threaddocker-compose.yml Outdated
Comment threaddocker-compose.yml Outdated
Comment threaddocker-compose.yml Outdated
@kszucs
kszucs requested a review from kouOctober 29, 2021 13:52
kou
kou approved these changes Oct 29, 2021

@koukou left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

+1

Comment threadci/scripts/js_build.sh Outdated
Comment threadci/scripts/python_build.sh Outdated
Comment threadci/scripts/r_build.sh Outdated
Comment threadci/scripts/c_glib_build.sh Outdated
Comment threaddocker-compose.yml Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Is there a point in building docs outside of the dedicated ubuntu-docs build?

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

Yes. The ubuntu-docs build can take more than 90 minutes so we shouldn't run that on all PRs. Instead we can build language specific docs for PRs and execute the full docs built on the master branch.

@kszucs
kszucsforce-pushed the build-docs-on-main-branch branch from bf1f042 to 1ffdf41CompareNovember 29, 2021 13:20

@kszucskszucs left a comment

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

+1, merging on green

@kszucs
kszucsforce-pushed the build-docs-on-main-branch branch from 1848bc1 to 1ffdf41CompareNovember 29, 2021 16:01
Comment thread.github/workflows/docs.yml Outdated
@kou

kou commented Nov 30, 2021

Copy link
Copy Markdown
Member

@jonkeane

Copy link
Copy Markdown
Member

I've got some cleanups / skips related to DuckDB in #11795. I'm ok merging this + #11795 separately, and if the docs builds still fail after that, I'll skip those examples until we can stabilize that integration (there are a few other tickets, and DuckDB is a bit of a moving target cause we sometimes need to wait for their upstream changes before we can test them reliably)

@kou

kou commented Nov 30, 2021

Copy link
Copy Markdown
Member

OK. I closed ARROW-14896.

@kszucs
kszucsforce-pushed the build-docs-on-main-branch branch from 2941ff4 to 7d70b79CompareDecember 1, 2021 18:16
@kszucs
kszucsforce-pushed the build-docs-on-main-branch branch from 7d70b79 to 896e856CompareDecember 1, 2021 21:34

@kszucskszucs left a comment

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

+1, merging on green

Comment thread.github/workflows/docs.yml Outdated
@kszucskszucs closed this in be9a22bDec 2, 2021
@ursabot

ursabot commented Dec 2, 2021

Copy link
Copy Markdown

Benchmark runs are scheduled for baseline = 55ebeb3 and contender = be9a22b. be9a22b is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2
[Failed ⬇️1.35% ⬆️0.0%] ursa-i9-9960x
[Finished ⬇️0.27% ⬆️0.18%] ursa-thinkcentre-m75q
Supported benchmarks:
ursa-i9-9960x: langs = Python, R, JavaScript
ursa-thinkcentre-m75q: langs = C++, Java
ec2-t3-xlarge-us-east-2: cloud = True

kou added a commit to kou/arrow that referenced this pull request Dec 4, 2021
A follow-up of apache#11567.
https://github.com/ursacomputing/crossbow/runs/4415960154?check_suite_focus=true
+ mkdir -p /build/docs/c_glib
+ rsync -a /usr/local/share/gtk-doc/html/ /build/docs/c_glib
/arrow/ci/scripts/c_glib_build.sh: line 52: rsync: command not found
127
kou added a commit that referenced this pull request Dec 5, 2021
A follow-up of #11567.
https://github.com/ursacomputing/crossbow/runs/4415960154?check_suite_focus=true
+ mkdir -p /build/docs/c_glib
+ rsync -a /usr/local/share/gtk-doc/html/ /build/docs/c_glib
/arrow/ci/scripts/c_glib_build.sh: line 52: rsync: command not found
127
Closes#11859 from kou/ci-debian-rsync
Authored-by: Sutou Kouhei <kou@clear-code.com>
Signed-off-by: Sutou Kouhei <kou@clear-code.com>
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants

@kszucs@kou@jonkeane@ursabot@jorisvandenbossche@pitrou@nealrichardson