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

stable to point to long-lived release branch #4305

Closed
mpharrigan opened this issue Jun 26, 2018 · 11 comments
Closed

stable to point to long-lived release branch #4305

mpharrigan opened this issue Jun 26, 2018 · 11 comments
Labels
Support Support question

Comments

@mpharrigan
Copy link

Details

Expected Result

Under "Versions" in the RTD docs, it says

Read the Docs supports two workflows for versioning: based on tags or branches. If you have at least one active tag, tags will take preference over branches when selecting the stable version.

Our project (https://github.com/rigetticomputing/pyquil) has a branch called 1.9 which we update with doc fixes. There is also a tag named v1.9.0 that is set to inactive on RTD. There are other tags which are all disabled. I would expect stable to track the tip of branch 1.9

Actual Result

RTD builds docs for the 1.9 branch just fine but stable still points to the (inactive) v1.9.0 tag

@stsewd
Copy link
Member

stsewd commented Jun 26, 2018

Not sure about this, maybe is part of the bug solved in #3913 (isn't deployed yet), or something else. Did you try wiping the environment before triggering a build? (Versions -> Edit -> Wipe)

@mpharrigan
Copy link
Author

I wiped latest, stable, 1.9 and v1.9.0 (this one is inactive) and triggered a build of stable but it re-built the tagged version instead of the tip of the 1.9 branch.

What's the time frame on deploying #3913?

@stsewd
Copy link
Member

stsewd commented Jun 27, 2018

@mpharrigan hopefully in one or two weeks I think, as you can see we don't have a specific time https://docs.readthedocs.io/en/latest/changelog.html

@mpharrigan
Copy link
Author

Thanks, I'll report back when that fix is deployed

@stsewd
Copy link
Member

stsewd commented Jul 6, 2018

@mpharrigan this fix was already deployed, can you test if that really solves your problem? You may need to wipe and rebuild another version. You need to do some additional steps if that doesn't work #3913 (comment)

@mpharrigan
Copy link
Author

No, it didn't seem to work. I tried various combinations of wiping and activate-deactivating the stable and 1.9 versions

@stsewd
Copy link
Member

stsewd commented Jul 9, 2018

Ok, I just imported your project locally, and indeed, this is another problem. We give priority to tags, even if they are inactive.

@stsewd
Copy link
Member

stsewd commented Jul 9, 2018

This was proposed in #3331

Selecting the stable version happens when syncing the versions from the repository, so all the branches and tags are considered.

@mpharrigan
Copy link
Author

Is this the intended behavior?

@stsewd
Copy link
Member

stsewd commented Jul 9, 2018

Yes, this is intended. You will need to remove all tags to rtd select the branch :/

@mpharrigan
Copy link
Author

Ah that's a bummer. I think the docs (quoted in my original post) should be changed then

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

No branches or pull requests

2 participants