Skip to content
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

Infra: Automatically edit PRs with link to RTD preview #3031

Merged
merged 1 commit into from Mar 1, 2023

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Feb 28, 2023

Once merged, this will automatically add a docs preview link to PRs.

GitHub Action that automatically edits Pull Requests' descriptions with a link to documentation's preview on Read the Docs.

https://github.com/readthedocs/actions/tree/v1/preview

For example: python/docs-community#75

@hugovk hugovk added the infra Core infrastructure for building and rendering PEPs label Feb 28, 2023
Copy link
Member

@CAM-Gerlach CAM-Gerlach left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks @hugovk ! Very useful improvement, especially after the recent UX-unfriendly changes for accessing them from the Details link in the checks list.

@CAM-Gerlach
Copy link
Member

CAM-Gerlach commented Mar 1, 2023

Maybe we could also adapt the action ourselves (as I don't see a currently published equivalent) to do the same thing for Netlify, for use on CPython? Not sure how hard that would be...

@hugovk hugovk merged commit d54d4e6 into python:main Mar 1, 2023
5 checks passed
@hugovk hugovk deleted the rtd-pr-preview branch March 1, 2023 11:52
@hugovk
Copy link
Member Author

hugovk commented Mar 1, 2023

Here's a demo:


And we'll probably need to add single-version: "true" here in PEPs so we get https://pep-previews--3018.org.readthedocs.build/ instead of https://pep-previews--3018.org.readthedocs.build/en/3018. Will wait for the next incoming PR to confirm.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infra Core infrastructure for building and rendering PEPs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants