Repository navigation
ARROW-12958: [CI][Developer] Build + host the docs for PR branches - #13913
Conversation
|
@github-actions crossbow submit -p pr_number=13913 preview-docs |
|
|
@github-actions crossbow submit -p pr_number=13913 preview-docs |
|
Revision: 8d77f242f2716f6de93773ff0fac9c2b62f3deb0 Submitted crossbow builds: ursacomputing/crossbow @ actions-76bab72639
|
8d77f24 to
3628cdf
Compare
|
@github-actions crossbow submit -p pr_number=13913 preview-docs |
|
Revision: 03a8233 Submitted crossbow builds: ursacomputing/crossbow @ actions-cff97e19a8
|
|
@github-actions crossbow submit -p pr_number=13913 preview-docs |
|
Revision: 4d0d4ee Submitted crossbow builds: ursacomputing/crossbow @ actions-6e06515170
|
| ci: github | ||
| template: r/github.packages.yml | ||
| params: | ||
| custom_version: Unset |
There was a problem hiding this comment.
This is a minor fix for an issue I noticed in this PR, namely that for params to work they have to be listed in tasks.yml. This also necessitates the replace( thing in the templates themselves as even empty params in task.yml are None and default does not trigger on None.
| pr_number: Unset | ||
| artifacts: "build/docs.tar.gz" | ||
| flags: "-v $PWD/build/:/build/" | ||
| image: ubuntu-docs No newline at end of file |
There was a problem hiding this comment.
| image: ubuntu-docs | |
| image: ubuntu-docs | |
| <groupId>pl.project13.maven</groupId> | ||
| <artifactId>git-commit-id-plugin</artifactId> | ||
| <version>2.2.2</version> | ||
| <version>4.0.5</version> |
There was a problem hiding this comment.
This plugin was causing problems with shallow copies, it should have been able to handle it but it looks like our version was too old. The new version introduces the cli switch I added to java_build.sh. This is now the newest possible version we can use as 5.0.0 does not support java < 11.
|
We will of course also need to add a "clean up"-job on crossbow that removes previews older than n-days (We could use the api to check if the pr is merged/closed but we have an issue with the cb gh-api limit already so I'd rather not spend it on this). When using @wjones127 @jorisvandenbossche review please? |
rok
left a comment
rok
left a comment
There was a problem hiding this comment.
This looks great @assignUser! I can't wait to use it.
Perhaps a follow up task (outside of this PR) could be also generating Go's docs.
|
We should probably document this in https://arrow.apache.org/docs/developers/documentation.html ? A nit about the URL: perhaps |
wjones127
left a comment
wjones127
left a comment
There was a problem hiding this comment.
This is awesome! I'm impressed you got this done this quickly.
The only thing I think needs improving in some reminder in the CI where the output of the docs is living.
Also, I guess clean up will be a follow up for later?
| git config --local user.email "[email protected]" | ||
| git add docs/pr/{{ pr_number }} | ||
| git commit -m "Add docs preview for PR {{ pr_number }}" | ||
| git push |
There was a problem hiding this comment.
Should we maybe echo the URL where the docs are hosted here? Just thinking it would be nice to have a reminder where they appear in the CI output.
|
@wjones127 How about something like this (open to text suggestions :D): https://github.com/assignUser/test-repo-a/actions/runs/2890950254 |
|
@github-actions crossbow submit -p pr_number=13913 preview-docs |
|
Revision: 5aaa225 Submitted crossbow builds: ursacomputing/crossbow @ actions-0d5323889b
|
|
Benchmark runs are scheduled for baseline = 4af3df0 and contender = 28cf3f9. 28cf3f9 is a master commit associated with this PR. Results will be available as each benchmark for each run completes. |
…pache#13913) Authored-by: Jacob Wujciak-Jens <[email protected]> Signed-off-by: Rok <[email protected]>
…pache#13913) Authored-by: Jacob Wujciak-Jens <[email protected]> Signed-off-by: Rok <[email protected]>
No description provided.