CI: Use new documentation previewer #57112
Merged
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
|
I'll be merging this soon if there are no objections, so we can use the previewer again (with the new service). |
mroeschke
reviewed
Jan 31, 2024
| else | ||
| curl -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" -d '{"body": "No preview found for PR #${{ github.event.issue.number }}. Did the docs build complete?"}' https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.issue.number }}/comments | ||
| fi | ||
| - uses: pandas-dev/github-doc-previewer@master |
There was a problem hiding this comment.
In the future it would be great if we could use a tag for stability but not a big issue
There was a problem hiding this comment.
Good point. At least for now I think all releases of the doc previewer will be done for pandas, but I created #57190 anyway, so we can decide when we upgrade.
mroeschke
approved these changes
Jan 31, 2024
|
Thanks all your hard work here @datapythonista |
|
I had to increase the timeout on nginx, since the requests stays life for a bit more than one minute until the preview is ready and the comment can be posted, but now everything seems to be working fine with the new version. |
pmhatre1
pushed a commit
to pmhatre1/pandas-pmhatre1
that referenced
this pull request
May 7, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
We've got a documentation previewer service for few months now, but the whole infrastructure powering it was just a PoC not very suitable for the long term (it didn't have error control, was running in a screen session, the workflow wasn't optimal, a github token was hardcoded, it required to remove old previews manually...).
Now we've got a service that IMHO is ready for production. Everything is built independently from pandas in this repo:
https://github.com/pandas-dev/github-doc-previewer/. In the pandas side the only thing we need is to call a GitHub action (check the diff in this PR).
For most people there won't be a significant difference between the previous PoC and the new system, as the UX is the same. Besides stability the main differences are:
/previewcomment). Previously we published the previews of every PR.pandas-devorganization is of course added. Not sure if we have any other repo where this can be useful, but only adding the GitHub action is enough to have previews enabled.Any feedback or problem please let me know.