Skip to content

Stable build reactivates upon project version release on GitHub #4012

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

Closed
stevepiercy opened this issue Apr 24, 2018 · 3 comments
Closed

Stable build reactivates upon project version release on GitHub #4012

stevepiercy opened this issue Apr 24, 2018 · 3 comments
Labels
Needed: replication Bug replication is required

Comments

@stevepiercy
Copy link
Contributor

Expected Result

We expect that once we untick a box in the project's Versions admin UI that it stays that way for all releases.

Actual Result

We suspect, but have not yet confirmed, that there is an unexpected behavior in RTD whenever we cut a new release of our project to GitHub. Here's what we think is happening.

  • At our project's Versions admin, we untick the Active checkbox for the stable version.
  • Months later, we cut a new release of Pyramid.
  • We notice that the previously mentioned checkbox has become ticked. 😮

Details

This is a difficult thing for us to test because we don't want to cut several releases to confirm. Sorry. The best we can do is watch for it the next time we cut a release.

We worked around it by setting the stable version to Active and Private. This makes it not public and removes it from the RTD pop-up version selector

However the stable build also returns a 404 for logged in admin users whom we expected to have the ability to view that build. Additionally for the stable build, the green button View Docs href attribute points to http://docs.pylonsproject.org/projects/pyramid/en/latest/, which I would expect to be http://docs.pylonsproject.org/projects/pyramid/en/stable/. Let me know if paragraph merits a separate issue report.

@humitos
Copy link
Member

humitos commented Apr 24, 2018

Just adding more context here (I didn't jump too deep into the code yet) but it seems that we are updateing the stable version only if it's active:

https://github.com/rtfd/readthedocs.org/blob/324cfb8d27aa56dd55a7c1c56389554eec95893f/readthedocs/projects/models.py#L760-L767

So, if you have untick the active field, it shouldn't be updated.

Additionally for the stable build, the green button View Docs href attribute points to http://docs.pylonsproject.org/projects/pyramid/en/latest, which I would expect to be http://docs.pylonsproject.org/projects/pyramid/en/stable

This is probably "bad UX": that green button always takes you to the default branch (defined in the Admin tab) documentation. Although, there is a new and tiny "View docs" link shown immediately after the build has finished and completed in the right side (below the date and seconds spent for building)

@humitos humitos added the Needed: replication Bug replication is required label Apr 24, 2018
@stsewd
Copy link
Member

stsewd commented Oct 26, 2018

Thanks for reporting, I'm closing this in favor of #4672, which I believe are the same problem. Also, I have a PR that fixes this #4733, if after mergin/releasing you notice the problem again, feel free to ask to reopen this issue, but I really think is the same problem (my pr doesn't fix only for latest, but in general).

@stsewd stsewd closed this as completed Oct 26, 2018
@stevepiercy
Copy link
Contributor Author

OK, I've subscribed to both the issue and the PR, so I can track when it's ready. We just released Pyramid 1.10a1, and we'll soon do the same switcheroo as the final release of 1.9.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: replication Bug replication is required
Projects
None yet
Development

No branches or pull requests

3 participants