Conversation
| name: doc-html | ||
| path: doc/build/html/ | ||
|
|
||
| - name: Create GitHub App token |
There was a problem hiding this comment.
@LiamConnors Curious why we need to create a new token as part of the workflow — is it because the token is very short-lived?
There was a problem hiding this comment.
I think it has something to do with the fact that this workflow is using a GitHub App rather than an access token.
There was a problem hiding this comment.
yes, that's it. we are using a GitHub App with short-lived tokens
camdecoster
left a comment
There was a problem hiding this comment.
Everything seems to be running/passing fine in the action. I'll wait to provide a final review until after you respond to questions.
| name: doc-html | ||
| path: doc/build/html/ | ||
|
|
||
| - name: Create GitHub App token |
There was a problem hiding this comment.
I think it has something to do with the fact that this workflow is using a GitHub App rather than an access token.
.github/workflows/build-doc.yml
Outdated
| python check-or-enforce-order.py build/html | ||
|
|
||
| - name: Upload HTML docs artifact | ||
| uses: actions/upload-artifact@v4 |
There was a problem hiding this comment.
You should use v6 if that doesn't break anything. v4 has been deprecated.
There was a problem hiding this comment.
Looks like there's a v7. Updated it. Thanks
.github/workflows/build-doc.yml
Outdated
| - name: List installed packages | ||
| run: | | ||
| cd doc | ||
| source .venv/bin/activate | ||
| uv pip list |
There was a problem hiding this comment.
Is this step needed? The install step should include the version info.
There was a problem hiding this comment.
Good point. Removed.
|
|
||
| - name: Build HTML docs | ||
| env: | ||
| MAPBOX_TOKEN: ${{ secrets.MAPBOX_TOKEN }} |
There was a problem hiding this comment.
Do we still need a Mapbox token? Haven't we converted to using Maplibre?
There was a problem hiding this comment.
Pages have Maplibre examples. but because there is still some usage of Mapbox and it hasn't been removed from the package yet, some pages still have an example - https://plotly.com/python/tile-scatter-maps/#mapbox-maps
| scikit-image==0.20.0 | ||
| scikit-learn | ||
| scipy==1.9.1 | ||
| setuptools<=81 |
Description of change
Updates docs build to use GitHub Actions instead of CircleCI. Needs following PR in graphing-library-docs to be merged also plotly/graphing-library-docs#426
Testing strategy
Tested manually by comparing output of builds for CircleCI vs GitHub Actions
Guidelines