devguide icon indicating copy to clipboard operation
devguide copied to clipboard

Replace deprecated workflow with RtD app

Open hugovk opened this issue 2 weeks ago • 3 comments

For https://github.com/python/core-workflow/issues/587.

This workflow is deprecated, and uses the pull_request_target target which can be insecure.

Let's test replacing it with the Read the Docs app. If it goes well, we can replace it in the other repos.

@python/organization-owners I've sent a request to install the RtD app for just this repo, please could you enable it?


📚 Documentation preview 📚: https://cpython-devguide--1713.org.readthedocs.build/

hugovk avatar Dec 09 '25 10:12 hugovk

@hugovk done

JacobCoffee avatar Dec 11 '25 21:12 JacobCoffee

Thanks!

I opened https://github.com/python/devguide/pull/1714 to test, but it doesn't seem to have triggered.

At least I can see it's installed on this repo:

image

Will check tomorrow.

hugovk avatar Dec 11 '25 22:12 hugovk

Right, figured it out on my fork: https://github.com/hugovk/devguide/pull/37

@Mariatta Please could you add hugovk as a maintainer at https://app.readthedocs.org/dashboard/cpython-devguide/users/ ?

Then I can complete the migration to the app and then check "Show build overview in a comment" at https://app.readthedocs.org/dashboard/cpython-devguide/pull-requests/

hugovk avatar Dec 12 '25 14:12 hugovk

@brettcannon Or please could you do the above to add me? https://github.com/python/devguide/pull/1713#issuecomment-3646684550

hugovk avatar Dec 17 '25 08:12 hugovk

@brettcannon Or please could you do the above to add me? #1713 (comment)

Invite sent!

brettcannon avatar Dec 17 '25 23:12 brettcannon

Thanks, accepted!

I don't see the migration option for this repo, I think it needs someone with admin access to the repo as well. I've added @JacobCoffee to RtD and will talk with him to get it set up.

hugovk avatar Dec 18 '25 19:12 hugovk

image

migrated everything, let me know if i can pick up any extra tasks

JacobCoffee avatar Dec 21 '25 02:12 JacobCoffee

Thanks @JacobCoffee!

A

AA-Turner avatar Dec 21 '25 08:12 AA-Turner

Let's keep discussion in this thread: paraphrasing myself from https://github.com/python/devguide/pull/1716#issuecomment-3678606090

The new RTD app comment hasn't appeared on any PRs yet, are there any settings we should check?

A

AA-Turner avatar Dec 21 '25 08:12 AA-Turner

From RTD project settings -> Building -> Integrations -> Spanner icon, python/devguide is listed as 'installed' but is not in the list of repositories. I selected the devguide repo & clicked 'update access', but got a permission error, only organisation owners can make changes. @JacobCoffee could you try this? Could be an unhelpful UI though, as this repo is listed as 'installed'.

image

AA-Turner avatar Dec 21 '25 09:12 AA-Turner

I've just checked "Show build overview in a comment" at https://app.readthedocs.org/dashboard/cpython-devguide/pull-requests/

image

And we now have a comment at https://github.com/python/devguide/pull/1714#issuecomment-3678619497 🚀

hugovk avatar Dec 21 '25 09:12 hugovk

Documentation build overview

📚 CPython devguide | 🛠️ Build #30772675 | 📁 Comparing a4e3608ffc2e86687e0bcdf698b53f318c24fc39 against latest (b24ed5025bb9efa6df0c638cdec81121f03ed8b3)


🔍 Preview build

Show files changed (1 files in total): 📝 1 modified | ➕ 0 added | ➖ 0 deleted
File Status
developer-workflow/development-cycle/index.html 📝 modified

Thanks all!

The comment is a little more verbose than before, but better to improve our security (& it does provide more info!).

A

AA-Turner avatar Dec 21 '25 09:12 AA-Turner