Skip to content

Previews in pull requests #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 13, 2023
Merged

Previews in pull requests #105

merged 3 commits into from
Feb 13, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Jan 31, 2023

Fixes #70.

#70 suggested Read the Docs and Netlify, but we have a bit of a bus factor problem with Netlify on the CPython docs due to only having a single account that can access the admin, so let's use Read the Docs as well. We're using it successfully in the PEPs repo.

Here's a demo build:

Draft because:

And we need to set up Read the Docs:

@hugovk hugovk mentioned this pull request Jan 31, 2023
@hugovk
Copy link
Member Author

hugovk commented Feb 6, 2023

Ping @Mariatta

@JDLH
Copy link

JDLH commented Feb 6, 2023

I wasn't aware of the term "bus factor". For the information of others like me, it refers to a risk that critical roles in a project are limited to a small number of people, in the sense of "in case they get hit by a bus". There is a nice Wikipedia article, Bus factor.

@hugovk hugovk changed the title Build CPython docs on Read the Docs Previews in pull requests Feb 6, 2023
@Mariatta
Copy link
Member

Mariatta commented Feb 6, 2023

Project created: https://readthedocs.org/projects/python-docs-theme-previews/

Who else should I add as maintainers?

@hugovk
Copy link
Member Author

hugovk commented Feb 6, 2023

Thanks! Maybe @JulienPalard, @ezio-melotti and me?

@pradyunsg
Copy link
Member

I'd be happy to be listed as well, if we don't have enough people. :)

@Mariatta
Copy link
Member

Mariatta commented Feb 6, 2023

I'll need your readthedocs usernames: @hugovk, @pradyunsg, @JulienPalard, @ezio-melotti

@pradyunsg
Copy link
Member

I'm pradyunsg (perhaps, unsurprisingly).

@hugovk
Copy link
Member Author

hugovk commented Feb 6, 2023

I'm hugovk (perhaps, unsurprisingly).

@Mariatta
Copy link
Member

Mariatta commented Feb 6, 2023

Invites sent.

@hugovk
Copy link
Member Author

hugovk commented Feb 7, 2023

I'll close this and re-open it as a new PR, and hopefully it will trigger an RTD build 🤞

@hugovk hugovk closed this Feb 7, 2023
@hugovk hugovk mentioned this pull request Feb 7, 2023
@hugovk
Copy link
Member Author

hugovk commented Feb 7, 2023

Nope, didn't trigger for #107, re-opening this.

It worked on my fork, I'll compare settings:

@hugovk hugovk reopened this Feb 7, 2023
@hugovk
Copy link
Member Author

hugovk commented Feb 7, 2023

OK, so the incoming GitHub webhook is good on my fork (at https://readthedocs.org/dashboard/hugovk-python-docs-theme/integrations/225260/):

Details image

And I also see a webhook (at https://github.com/hugovk/python-docs-theme/settings/hooks):

Details image

But not for this repo (at https://readthedocs.org/dashboard/python-docs-theme-previews/integrations/225787/):

Details image

If I click "Resync webhook" I get "Webhook activation failed. Make sure you have the necessary permissions", which makes sense as I don't have admin permissions here.


@Mariatta Please can you try the "Resync webhook" button at https://readthedocs.org/dashboard/python-docs-theme-previews/integrations/225787/?

And is there anything at https://github.com/python/python-docs-theme/settings/hooks?

@hugovk
Copy link
Member Author

hugovk commented Feb 7, 2023

Łukasz has enabled we hooks. 🎣

Close/re-open to retrigger...

@hugovk hugovk closed this Feb 7, 2023
@hugovk hugovk reopened this Feb 7, 2023
@hugovk hugovk marked this pull request as ready for review February 7, 2023 21:37
@hugovk
Copy link
Member Author

hugovk commented Feb 7, 2023

Deploy preview is now built!

Ready for review!

https://python-docs-theme-previews--105.org.readthedocs.build/en/105/

@pradyunsg pradyunsg merged commit 506e0f2 into python:main Feb 13, 2023
@hugovk hugovk deleted the rtd-preview branch February 13, 2023 11:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Previews in pull requests
4 participants