Fix website build failure caused by python doc generate script #10668
Conversation
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
BewareMyPower
requested review from
codelipenghui,
eolivelli,
merlimat and
tuteng
eolivelli
reviewed
May 21, 2021
Contributor
eolivelli
left a comment
eolivelli
left a comment
There was a problem hiding this comment.
I am testing it locally.
thank you very much !
|
|
||
| BUILD_IMAGE_NAME="${BUILD_IMAGE_NAME:-apachepulsar/pulsar-build}" | ||
| BUILD_IMAGE_VERSION="${BUILD_IMAGE_VERSION:-ubuntu-16.04}" | ||
| BUILD_IMAGE_VERSION="${BUILD_IMAGE_VERSION:-ubuntu-16.04-py2}" |
Contributor
There was a problem hiding this comment.
where and how do we build this image ?
apachepulsar/pulsar-build:ubuntu-16.04-py2
Contributor
Author
There was a problem hiding this comment.
The image was uploaded manually by @merlimat before. The dockerfile is build/docker/Dockerfile.
Contributor
|
The change makes sense to me but if I run the script locally I see this error: |
eolivelli
approved these changes
May 21, 2021
Contributor
Author
I think you have built the website before? I think you need to remove the local directory first. |
Contributor
Author
|
Because the build script starts a docker container and maps the Pulsar project directory to I think it's a minor bug of the script that it uses |
Contributor
Author
|
I just built it in my local env. I'm not sure if it's a failure Anyway all |
Contributor
|
@BewareMyPower does the website renders correctly on your machine ? |
Contributor
Author
|
As for 2.8.0-SNAPSHOT URLs, they're the same with those URLs without 2.8.0-SNAPSHOT. PS. |
codelipenghui
approved these changes
May 21, 2021
Contributor
|
great |
yangl
pushed a commit
to yangl/pulsar
that referenced
this pull request
Jun 23, 2021
### Motivation The CI - Pulsar Website Build has been broken for a long time. Here's an example run: https://github.com/apache/pulsar/runs/2635024657?check_suite_focus=true ``` CMake Error at python/CMakeLists.txt:85 (MESSAGE): -- Using Boost Python libs: Could not find Boost Python library ``` It looks like to be the same issue with apache#9682. apache#9690 fixed the broken CI for cpp client but the `ci-pulsar-website-build.yaml` wasn't modified. Another issue is after I fixed the cpp build for website build, the `python-doc-gen.sh` still failed because the default `pdoc` is a Python3 tool ``` + pdoc pulsar --html --html-dir /pulsar/generated-site/api/python/2.8.0-SNAPSHOT Traceback (most recent call last): File "/usr/local/bin/pdoc", line 7, in <module> from pdoc.__main__ import cli File "/usr/local/lib/python3.5/dist-packages/pdoc/__init__.py", line 328 ) -> str: ^ ``` So we need to install a Python2 version `pdoc` as well. ### Modifications - Use `ubuntu-16.04-py2` tag instead of old `ubuntu-16.04` tag in `docker-build-site.sh` and force CMake to find Python2 in `python-doc-gen.sh`. The the Pulsar Python client library could be built successfully. - Install a Python2 version `pdoc` in `python-doc-gen.sh`.
bharanic-dev
pushed a commit
to bharanic-dev/pulsar
that referenced
this pull request
Mar 18, 2022
### Motivation The CI - Pulsar Website Build has been broken for a long time. Here's an example run: https://github.com/apache/pulsar/runs/2635024657?check_suite_focus=true ``` CMake Error at python/CMakeLists.txt:85 (MESSAGE): -- Using Boost Python libs: Could not find Boost Python library ``` It looks like to be the same issue with apache#9682. apache#9690 fixed the broken CI for cpp client but the `ci-pulsar-website-build.yaml` wasn't modified. Another issue is after I fixed the cpp build for website build, the `python-doc-gen.sh` still failed because the default `pdoc` is a Python3 tool ``` + pdoc pulsar --html --html-dir /pulsar/generated-site/api/python/2.8.0-SNAPSHOT Traceback (most recent call last): File "/usr/local/bin/pdoc", line 7, in <module> from pdoc.__main__ import cli File "/usr/local/lib/python3.5/dist-packages/pdoc/__init__.py", line 328 ) -> str: ^ ``` So we need to install a Python2 version `pdoc` as well. ### Modifications - Use `ubuntu-16.04-py2` tag instead of old `ubuntu-16.04` tag in `docker-build-site.sh` and force CMake to find Python2 in `python-doc-gen.sh`. The the Pulsar Python client library could be built successfully. - Install a Python2 version `pdoc` in `python-doc-gen.sh`.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Motivation
The CI - Pulsar Website Build has been broken for a long time. Here's an example run: https://github.com/apache/pulsar/runs/2635024657?check_suite_focus=true
It looks like to be the same issue with #9682. #9690 fixed the broken CI for cpp client but the
ci-pulsar-website-build.yamlwasn't modified.Another issue is after I fixed the cpp build for website build, the
python-doc-gen.shstill failed because the defaultpdocis a Python3 toolSo we need to install a Python2 version
pdocas well.Modifications
ubuntu-16.04-py2tag instead of oldubuntu-16.04tag indocker-build-site.shand force CMake to find Python2 inpython-doc-gen.sh. The the Pulsar Python client library could be built successfully.pdocinpython-doc-gen.sh.Verifying this change
This change is a trivial rework / code cleanup without any test coverage.