Skip to content

Rename tagged version build with a human-readable name #12057

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
sarina opened this issue Mar 18, 2025 · 12 comments
Closed

Rename tagged version build with a human-readable name #12057

sarina opened this issue Mar 18, 2025 · 12 comments
Labels
Needed: more information A reply from issue author is required Support Support question

Comments

@sarina
Copy link

sarina commented Mar 18, 2025

What's the problem this feature will solve?

We have a complicated release system, where we don't explicitly tag transitive dependencies with the human-readable release name. So we have a repo, XBlock, with the tag v5.1.0 that is included in our Sumac release. We don't make a Sumac branch on this repo. I'd like to make a docs build from the v5.1.0 tag with the book name of Sumac.

Describe the solution you'd like

I want to build from a tag, but have the name in the switcher on the RTD page to be the name of the release.

Alternative solutions

I can't find a way to do this.

Additional context

openedx/docs.openedx.org#941

We do explicitly make a branch on our main docs site, https://docs.openedx.org/en/latest/, with the human-readable release name. So we want our associated books to match.

Image

@humitos
Copy link
Member

humitos commented Mar 18, 2025

This use case seems to be a good candidate to try "editable versions": #11930 cc @stsewd

@sarina
Copy link
Author

sarina commented Mar 18, 2025

Ohhh that looks great, thank you. I don't see that option though on my dashboard:

Image

@humitos
Copy link
Member

humitos commented Mar 18, 2025

@sarina yeah, no, it's behind a feature flag under beta. We can enable it for you if you want to give it a try. Let us know.

@humitos humitos added Needed: more information A reply from issue author is required Support Support question labels Mar 18, 2025
@stsewd
Copy link
Member

stsewd commented Mar 18, 2025

Hi, we allow changing the slug (under a feature flag), but be aware of some restrictions #10674 (comment), mainly the one about sorting, if you care about that.

@sarina
Copy link
Author

sarina commented Mar 18, 2025

@stsewd @humitos that would be amazing, thank you so much!

@stsewd
Copy link
Member

stsewd commented Mar 18, 2025

I have enabled the feature for your project (xblock-docsopenedxorg), you should be able to see the slug field in the form now.

@sarina
Copy link
Author

sarina commented Mar 18, 2025

Thank you!

Is it possible to enable across our org, or should I enumerate the transitive dependencies we have that need this option?

@stsewd
Copy link
Member

stsewd commented Mar 18, 2025

@sarina we need the list of projects in order to enable the feature.

@sarina
Copy link
Author

sarina commented Mar 18, 2025

No problem. Could you please enable on the following:

  • openedx-filters
  • DoneXBlock
  • openedx-wordpress-ecommerce
  • openedx-events
  • event-routing-backends
  • openedx-aspects

Thanks so much!!! 🙇‍♀

@stsewd
Copy link
Member

stsewd commented Mar 18, 2025

Done!

@sarina
Copy link
Author

sarina commented Mar 19, 2025

You're the best, @stsewd . I'm going to close this issue. If we want this enabled on future projects, is it better to open a new issue in this repo or email the support team?

@sarina sarina closed this as completed Mar 19, 2025
@stsewd
Copy link
Member

stsewd commented Mar 19, 2025

Email is the best option. We are also planning into making this feature available for everyone, hopefully that happens soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: more information A reply from issue author is required Support Support question
Projects
None yet
Development

No branches or pull requests

3 participants