Skip to content

CI (DOC/WEB): replace upload to server with push to github pages repo - #66809

Open
jorisvandenbossche wants to merge 5 commits into
pandas-dev:mainfrom
jorisvandenbossche:doc-upload
Open

CI (DOC/WEB): replace upload to server with push to github pages repo#66809
jorisvandenbossche wants to merge 5 commits into
pandas-dev:mainfrom
jorisvandenbossche:doc-upload

Conversation

@jorisvandenbossche

Copy link
Copy Markdown
Member

xref #64703

This updates the doc build workflow to rsync to a checkout of https://github.com/pandas-dev/pandas-dev.github.io instead of to the (no longer running) server. And then creates a commit and pushes that to the repo.

Pushing to a different repo will need an access token or deploy key (to be saved as PANDAS_DEV_GITHUB_IO_TOKEN) that can write to pandas-dev/pandas-dev.github.io (still have to set this up, and check that pushing to the pages repo will be allowed that way).
It seems that the deploy key is regarded as a safer option than the personal access token. And I don't think there is a way around using one of those two (except for creating a custom github app)

@jorisvandenbossche jorisvandenbossche added Docs CI Continuous Integration Web pandas website labels Aug 17, 2026
Comment thread .github/workflows/docbuild-and-upload.yml Fixed
Comment thread .github/workflows/docbuild-and-upload.yml Fixed

@rhshadrach rhshadrach 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.

Edit: Noting this has been taken care of by #66876

I believe the URL will still point to e.g. 2.3.4 instead of 2.3 in index.html

<a href="https://pandas.pydata.org/pandas-docs/version/{{ release.name }}/">docs</a> |

Comment thread .github/workflows/docbuild-and-upload.yml
Comment thread .github/workflows/docbuild-and-upload.yml Outdated
Comment thread web/pandas_web.py

@rhshadrach rhshadrach 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.

lgtm - I figure we should merge this when the bandwidth is available to handle any issues. I think you can go ahead when ready @jorisvandenbossche, I can maybe do it next week at the earliest.

@jorisvandenbossche

Copy link
Copy Markdown
Member Author

Good idea, I still some time today, but let's play safe, and I'll merge on Monday morning, then I have a full week available for follow-ups.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CI Continuous Integration Docs Web pandas website

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants