Config file: add support for latest aliases #11081
Conversation
- Closes #8861 - Closes #10912 Ref readthedocs/meta#140
There was a problem hiding this comment.
It looks good to me 🎉
I left some improvement suggestions on the documentation trying to make those sentences more clear. Besides, we need to change the name of the Ubuntu latest to ubuntu-lts-latest as we discussed.
I just want to make sure we are all on the same page regarding this change before merging.
docs/user/config-file/v2.rst
Outdated
| The ``ubuntu-latest-lts`` option refers to the latest LTS version of Ubuntu available on Read the Docs, | ||
| not the latest LTS version available. |
There was a problem hiding this comment.
This sentence is confusing. In particular the final part saying "not the latest LTS version available"
| The ``ubuntu-latest-lts`` option refers to the latest LTS version of Ubuntu available on Read the Docs, | |
| not the latest LTS version available. | |
| The ``ubuntu-lts-latest`` option refers to the latest Ubuntu LTS version available on Read the Docs, | |
| which may not match with the latest Ubuntu LTS officially released. |
docs/user/config-file/v2.rst
Outdated
|
|
||
| .. warning:: | ||
|
|
||
| Using ``ubuntu-latest-lts`` may break your builds unexpectedly if your project isn't compatible with the latest version when it's updated. |
There was a problem hiding this comment.
| Using ``ubuntu-latest-lts`` may break your builds unexpectedly if your project isn't compatible with the latest version when it's updated. | |
| Using ``ubuntu-lts-latest`` may break your builds unexpectedly if your project isn't compatible with the newest Ubuntu LTS version released when Read the Docs upgrades to it. |
docs/user/config-file/v2.rst
Outdated
| Each tool has a ``latest`` option available, which refers to the latest version available on Read the Docs, | ||
| not the latest version available. Versions are updated at least once every six months. |
There was a problem hiding this comment.
| Each tool has a ``latest`` option available, which refers to the latest version available on Read the Docs, | |
| not the latest version available. Versions are updated at least once every six months. | |
| Each tool has a ``latest`` option available, which refers to the latest version available on Read the Docs, | |
| which may not match with the latest version officially released by the tool. | |
| `latest` versions are updated every 6 months to point to the latest version officially released. |
There was a problem hiding this comment.
I kept the at least once part
|
|
||
| Each tool has a ``latest`` option available, which refers to the latest version available on Read the Docs, | ||
| which may not match the latest version officially released. | ||
| Versions and the ``latest`` option are updated at least once every six months to keep up with the latest releases. |
There was a problem hiding this comment.
Are we documenting what latest currently points to? Seems like that would be useful information, but also a pain to update.
There was a problem hiding this comment.
Was hoping that (alias for the latest version available on Read the Docs) on each tag would be enough given the list of all available versions.
There was a problem hiding this comment.
So it's basically the same as the first item in the list?
There was a problem hiding this comment.
This is looking good to me and I think it's ready to merge.
There are only these two points we may want to keep talking about:
- Config file: add support for latest aliases #11081 (comment)
- Config file: add support for latest aliases #11081 (comment)
but I think they are not blockers 👍🏼
|
Feel free to merge if you think this should go out with tomorrows deploy! |
readthedocs/readthedocs.org#11081 Signed-off-by: Bradley Reynolds <[email protected]>
* Update .readthedocs.yaml to not pin tooling versions readthedocs/readthedocs.org#11081 Signed-off-by: Bradley Reynolds <[email protected]> * Strip blank lines Signed-off-by: Bradley Reynolds <[email protected]> --------- Signed-off-by: Bradley Reynolds <[email protected]>
…test` (#11098) * Build: check for pre-compiled `build.tools` when using `ubuntu-lts-latest` Related #11081 * Update readthedocs/doc_builder/director.py Co-authored-by: Santos Gallegos <[email protected]> --------- Co-authored-by: Santos Gallegos <[email protected]>
build.os#8861latestversions of conda/mamba/ in.readthedocs.yml#10912Ref https://github.com/readthedocs/meta/discussions/140
📚 Documentation previews 📚
docs): https://docs--11081.org.readthedocs.build/en/11081/dev): https://dev--11081.org.readthedocs.build/en/11081/