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

Fix the format of the readthedocs config file. #113

Merged
merged 1 commit into from
Feb 13, 2025

Conversation

jguiditta
Copy link
Member

Docs were no longer building due to a schema change on readthedocs.

Docs were no longer building due to a schema change on readthedocs.

Signed-off-by: Jason Guiditta <jguiditt@redhat.com>
@jguiditta
Copy link
Member Author

Changes build docs successfully. They can be seen here:
https://test-git-wrapper.readthedocs.io/en/latest/

Copy link
Contributor

@jpichon jpichon left a comment

Choose a reason for hiding this comment

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

LGTM ;)

I'm not seeing the "Changelog" link in the menu of the test docs vs the current docs, when I think it's quite handy to have, but not sure if it's just a test vs real env difference or if there was another format change somewhere.

@jguiditta
Copy link
Member Author

jguiditta commented Feb 12, 2025

LGTM ;)

I'm not seeing the "Changelog" link in the menu of the test docs vs the current docs, when I think it's quite handy to have, but not sure if it's just a test vs real env difference or if there was another format change somewhere.

This is a good observation, and thanks for the review! I did some looking, and I believe this is just because of how I have my test project set up on readthedocs. I have it pointed to a specific branch, and it does a shallow clone, so there are no tags. This causes our tooling which generates the changelog to give this output:

change stderr returns: couldn't find any valid version tags
couldn't find CHANGELOG.md

I was able to verify that no tags are present in the checkout when done the way test rtd does it. If we see this is still misbehaving on merge, I will follow up with another patch fixing it, if no objections.

@jpichon
Copy link
Contributor

jpichon commented Feb 12, 2025

That sounds absolutely reasonable, thank you for checking and for the explanation!

Copy link

@evallesp evallesp left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

@eggmaster eggmaster 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 for fixing this!

@eggmaster eggmaster merged commit f3c9fc3 into release-depot:master Feb 13, 2025
8 checks passed
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

Successfully merging this pull request may close these issues.

4 participants