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

Provides a way to set the "stable" version manually #3279

Closed
humitos opened this issue Nov 17, 2017 · 16 comments
Closed

Provides a way to set the "stable" version manually #3279

humitos opened this issue Nov 17, 2017 · 16 comments
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors Improvement Minor improvement to code Needed: documentation Documentation is required
Milestone

Comments

@humitos
Copy link
Member

humitos commented Nov 17, 2017

This issue comes from #3268 (comment)

I think it could be a good nice to have, so I'm opening this issue so we can discuss here if it would be better or it could be more confusing at the end.

Besides, how it should be implemented in the UI; I image it

  • in the "Admin -> Versions" page a stable title with an input and a description "Leave it blank to use the RTD default logic to determine the stable version")
  • as a setting somewhere in the yaml file
@humitos humitos added Improvement Minor improvement to code Needed: design decision A core team decision is required labels Nov 17, 2017
@ericholscher ericholscher added this to the YAML File Completion milestone Dec 21, 2017
@aasis21
Copy link
Contributor

aasis21 commented Mar 1, 2018

@humitos @ericholscher, I would like to take up this issue. For UI part we can give a ChoiceField, so that there is also no validation issue. What do you say?
And in yaml file, we can give a stable_version:version_name

@sfdye
Copy link

sfdye commented Mar 2, 2018

+1 for this feature, my build is failing because stable is not able figure out the latest tagged release

@ericholscher
Copy link
Member

Isn't the way to do this to just create your own branch named "stable" and use that?

@sfdye
Copy link

sfdye commented Mar 8, 2018

@ericholscher I thought rtd will automatically pick up the latest release tag as stable version?

@ericholscher
Copy link
Member

It should, but this ticket is about specifying it manually. If there is a bug in our version resolution, that is a separate issue.

@sfdye
Copy link

sfdye commented Mar 8, 2018

@ericholscher that would be my #3714

@agjohnson
Copy link
Contributor

Moving this out of the YAML milestone. If we did implement anything here, I don't think we'd want it linked to the YAML file.

@stsewd
Copy link
Member

stsewd commented Apr 11, 2018

RTD allow overriding the stable version by creating a branch or tag named stable (it's a little buggy right now #3913), isn't that what we want?

@stsewd
Copy link
Member

stsewd commented Oct 25, 2018

Not sure if this is something we can put on our yaml, per-version settings only. This looks like a project setting.

@ericholscher
Copy link
Member

I feel like the answer here should be "If you want a custom stable version, create either a tag or branch in your project with that name." Do we want to apply the same logic to latest as well? If so, we should likely document this, and then make sure the code works that way :)

@stsewd
Copy link
Member

stsewd commented Nov 1, 2018

Currently, users can specify a custom latest on the web admin, I think the major feature here is that user's don't want to maintain 2 branches/tags, say they want my-stable be just stable.

@humitos
Copy link
Member Author

humitos commented Jan 9, 2019

I think the major feature here is that user's don't want to maintain 2 branches/tags, say they want my-stable be just stable.

I think we don't want to add another setting for this only to support this case.

"If you want a custom stable version, create either a tag or branch in your project with that name."

I suppose that we can document this and just close this issue.

@humitos humitos added Needed: documentation Documentation is required and removed Needed: design decision A core team decision is required labels Jan 9, 2019
@stale
Copy link

stale bot commented Feb 23, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the Status: stale Issue will be considered inactive soon label Feb 23, 2019
@stsewd
Copy link
Member

stsewd commented Feb 25, 2019

This can be closed in favor of #5319, but we could still document that people can create a version named latest or stable

@stale stale bot removed the Status: stale Issue will be considered inactive soon label Feb 25, 2019
@humitos
Copy link
Member Author

humitos commented Feb 25, 2019

Yes. The only actionable thing missing from this issue is the documentation part #3279 (comment)

@humitos humitos added the Accepted Accepted issue on our roadmap label Feb 25, 2019
@stsewd stsewd added the Good First Issue Good for new contributors label Mar 1, 2019
@agarwalrounak
Copy link
Contributor

I will work on it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors Improvement Minor improvement to code Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

7 participants