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

Documentation build is no longer automatically triggered on ReadTheDocs #2484

Closed
stefan6419846 opened this issue Feb 28, 2024 · 15 comments
Closed
Assignees
Labels

Comments

@stefan6419846
Copy link
Collaborator

Read the Docs currently seems to ship the docs for version 4.0.1 at the moment, although 4.0.2 has been released in the meantime.

I initially stumbled upon this due to the incomplete changelog at https://pypdf.readthedocs.io/en/latest/meta/CHANGELOG.html According to the build history, version 4.0.2 has never been triggered at all: https://readthedocs.org/projects/pypdf/builds/

@stefan6419846
Copy link
Collaborator Author

@MartinThoma Do you have an idea why the last release apparently did not trigger the docs build?

@j-t-1
Copy link
Contributor

j-t-1 commented Mar 26, 2024

Is it possible that as pypdf has grown it now times out the process? Are there any log files produced?

@MasterOdin
Copy link
Member

From the https://readthedocs.org/projects/pypdf/builds/ link, it would seem that RTD was being regularly triggered on any commit to main as well as new tags until the 4.0.1 release (7579329), at which point no builds were triggered going forward.

I wonder if @MartinThoma had revoked something in RTD that made it no longer able to pick up new commits to the repo and build the appropriate latest or stable tags.

@stefan6419846
Copy link
Collaborator Author

Yes, this is something which most likely only Martin can answer, thus I assigned him directly. RTD has at least some basic configuration options regarding this.

@MartinThoma
Copy link
Member

I only noticed this ticket. Sorry for the delay. I'll have a look today.

@py-pdf py-pdf deleted a comment from stefan6419846 Mar 27, 2024
@py-pdf py-pdf deleted a comment from Evan0000000000 Mar 27, 2024
@py-pdf py-pdf deleted a comment from Evan0000000000 Mar 27, 2024
@MartinThoma
Copy link
Member

I wonder if @MartinThoma had revoked something in RTD that made it no longer able to pick up new commits to the repo and build the appropriate latest or stable tags.

I didn't touch RTD for quite a while

@MartinThoma
Copy link
Member

image

@MartinThoma
Copy link
Member

I've re-connected / gave the permissions, but RTD still claims that it does not have access. I manually triggered the build now.

@MartinThoma
Copy link
Member

@MartinThoma
Copy link
Member

Ok, I think things look good now. Hever, I still see the error message on RTD from above:

Could not send GitHub build status report for "pypdf". Make sure you have the correct GitHub repository permissions and your GitHub account is connected to Read the Docs.

@MartinThoma
Copy link
Member

image

Seems to work, though

@stefan6419846
Copy link
Collaborator Author

Thanks, it seems to be running again, although more often than before? In the past, we would only update the docs on a release/tag, now it seems like even PRs get a dedicated rendered page and each commit to the main branch triggers an up-to-date build. This should not really hurt, I just happened to stumble upon this when looking at my latest PR ;)

@pubpub-zz
Copy link
Collaborator

Thanks, it seems to be running again, although more often than before? In the past, we would only update the docs on a release/tag, now it seems like even PRs get a dedicated rendered page and each commit to the main branch triggers an up-to-date build. This should not really hurt, I just happened to stumble upon this when looking at my latest PR ;)

I've seen the same. From an ecological point of view this is not so good. What about checking if the title starts with REL: to engage the process ?

@MartinThoma
Copy link
Member

MartinThoma commented Mar 27, 2024

I started the build process a couple of times manually. Maybe you have seen that?

However, we did run it for every single PR as well since many months. The reason is that we can check changes in the docs before we merge it.

@MartinThoma MartinThoma changed the title Read the Docs is outdated Documentation build is no longer automatically triggered on ReadTheDocs Mar 27, 2024
@pubpub-zz
Copy link
Collaborator

I close this as solved. If we observe the issue back, we will reopen it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

5 participants