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.

Sign up for GitHub

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

Jump to bottom

Add readthedocs/actions/preview to GHA for doc build status checks and PR previews #2949

Open
Helveg opened this issue Sep 19, 2023 · 0 comments
Open

Add readthedocs/actions/preview to GHA for doc build status checks and PR previews #2949

Helveg opened this issue Sep 19, 2023 · 0 comments
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Enhancement New functionality, model or documentation
Projects
Documentation

Comments

@Helveg
Copy link
Contributor

Helveg commented Sep 19, 2023

Is your feature request related to a problem? Please describe.

I believe we currently fidget a lot ourselves to get RTD builds incorporated into our GHA workflow @jessica-mitchell / @terhorstd ? But an official RTD action exists:

https://github.com/readthedocs/actions

With the preview action enabled, every status check gets a docs/readthedocs.org:<repo>— Read the Docs build succeeded! line item, and a Details link to the preview docs of that PR!

Check it out on the PR where I discovered it:

pypa/cibuildwheel#1620

Which links to my preview where my changes are immediately visible:

https://cibuildwheel--1620.org.readthedocs.build/en/1620/options/#debugging
@jessica-mitchell jessica-mitchell added this to To do in Documentation via automation Sep 19, 2023
@terhorstd terhorstd added T: Enhancement New functionality, model or documentation S: Normal Handle this with default priority I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Oct 20, 2023
@Helveg Helveg mentioned this issue Oct 26, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Enhancement New functionality, model or documentation
Projects
Documentation
  
To do
Milestone
No milestone
Development

No branches or pull requests
2 participants
@terhorstd @Helveg