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

Once we release 2.1.150, Restore RTD "default version" to it if needed. #2267

Closed
benjyw opened this issue Oct 13, 2023 · 6 comments
Closed
Assignees

Comments

@benjyw
Copy link
Collaborator

benjyw commented Oct 13, 2023

A change in RTD's own settings caused the 2.1.148 doc build to break.

The breakage has been fixed in #2266, so the next release's docs will build. But until then, I've manually configured the "default version" on RTD's Admin -> Advanced Settings, which pointed to "v2.1.148" to point to "latest", so that https://pex.readthedocs.io/ isn't broken. ("latest" points to the latest SHA, not the latest release, AFAICT).

Once 2.1.149 is released we may need to manually repoint it (or this may happen automatically, I haven't dug into how RTD normally updates this).

@benjyw benjyw self-assigned this Oct 13, 2023
@benjyw benjyw mentioned this issue Oct 13, 2023
1 task
@jsirois jsirois mentioned this issue Nov 2, 2023
2 tasks
@jsirois
Copy link
Member

jsirois commented Nov 2, 2023

It looks like this automation rule handles activating any new incoming tag as the default version; so the ship should right itself automatically: https://readthedocs.org/dashboard/pex/rules/regex/865/

@jsirois
Copy link
Member

jsirois commented Nov 3, 2023

Alrighty. They are changing all the things - new failure: https://readthedocs.org/projects/pex/builds/22435029/:

image

The fix for that is outlined here: https://blog.readthedocs.com/migrate-configuration-v2/

jsirois added a commit to jsirois/pex that referenced this issue Nov 3, 2023
jsirois added a commit that referenced this issue Nov 3, 2023
jsirois added a commit to jsirois/pex that referenced this issue Nov 3, 2023
The fix in pex-tool#2274 that introduced `.readthedocs.yaml` (the name
documented by RTD currently to use for the config file) was blind to the
fact we already had a `.readthedocs.yml` file. It appears to be the case
that `.readthedocs.yml` is both read by RTD and preferred; so RTD build
errors persisted. Fix this by merging the config files and sticking with
the current reccomended name of `.readthedocs.yaml`.

More work towards pex-tool#2267.
@benjyw
Copy link
Collaborator Author

benjyw commented Nov 3, 2023

It looks like this automation rule handles activating any new incoming tag as the default version; so the ship should right itself automatically: https://readthedocs.org/dashboard/pex/rules/regex/865/

I'd hoped that was the case, but I wasn't sure if my manually resetting it would somehow prevent it automatically righting itself (I didn't dig into how those get set, but I concur that this automation rule should do the trick).

@jsirois
Copy link
Member

jsirois commented Nov 3, 2023

Yeah - it did do the trick. The now-failing-in-a-new-way RTD build has undone your manual pointing fix. You should find https://pex.readthedocs.io -> https://pex.readthedocs.io/en/v2.1.149/ which is broken now.

jsirois added a commit that referenced this issue Nov 3, 2023
The fix in #2274 that introduced `.readthedocs.yaml` (the name
documented by RTD currently to use for the config file) was blind to the
fact we already had a `.readthedocs.yml` file. It appears to be the case
that `.readthedocs.yml` is both read by RTD and preferred; so RTD build
errors persisted. Fix this by merging the config files and sticking with
the current reccomended name of `.readthedocs.yaml`.

More work towards #2267.
@jsirois jsirois changed the title Once we release 2.1.149, Restore RTD "default version" to it Once we release 2.1.150, Restore RTD "default version" to it if needed. Nov 3, 2023
@jsirois
Copy link
Member

jsirois commented Nov 3, 2023

Ok, #2275 has fixed the RTD build and I've pointed the default version at latest for now. Hopefully the 2.1.150 Pex release triggers a self-righting of the default version.

@jsirois jsirois mentioned this issue Nov 4, 2023
2 tasks
@jsirois jsirois self-assigned this Nov 4, 2023
@jsirois
Copy link
Member

jsirois commented Nov 4, 2023

Ok, the auto-reset worked. https://pex.readthedocs.io now re-directs to https://pex.readthedocs.io/en/v2.1.150/ with no intervention on my part.

@jsirois jsirois closed this as completed Nov 4, 2023
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

No branches or pull requests

2 participants