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

Add alias support to version automation #5318

Open
2 tasks
agjohnson opened this issue Feb 20, 2019 · 3 comments
Open
2 tasks

Add alias support to version automation #5318

agjohnson opened this issue Feb 20, 2019 · 3 comments
Assignees
Labels
Accepted Accepted issue on our roadmap Feature New feature Sprintable Small enough to sprint on
Milestone

Comments

@agjohnson
Copy link
Contributor

agjohnson commented Feb 20, 2019

In #4001 we started by adding version automation rules to enable new versions.

In this next phase, we will address the use case of automation of version aliases. Prior to this, we might need to refactor how we are managing version alias, and potentially more widely support alias management in our UI.

Example use cases here are:

  • User want to set up aliases for minor versions that point to bugfix releases. For instance, a project has 1.0, 1.1, and 2.0 versions active in docs. On release of 2.0.5, the 2.0 alias will automatically repoint to this new tag
  • User has an odd branch naming convention, wants to automate adding versions derived from these branch names. For instance, project repository uses major version branches for backporting use and wants version-3.0 to show up as 3.0 automatically.

Some rule example psuedo logic are:

  • On [Regex match /2.1.[\d+]/], [Set alias 2.1]
  • On [Regex match /([\d+]).([\d+]).[\d+]/], [Set alias {match[0]}.{match[1]}]

Work

  • Add an action "Set alias". This action supports some templating, such as the docker hub version automation -- {major}, {minor}, {\1} (regex grouping), etc
  • Add UI pieces for rules, if anything new is required in our UI
@agjohnson agjohnson added Feature New feature Accepted Accepted issue on our roadmap labels Feb 20, 2019
@agjohnson agjohnson added this to the Admin UX milestone Feb 20, 2019
@stsewd stsewd self-assigned this Feb 20, 2019
@stsewd
Copy link
Member

stsewd commented Sep 24, 2019

Another use case is for users that have versions not compatible with pep 440, instead of renaming all of their versions, they can just rename the slug on rtd and automate this with automation rules. We want to allow users to edit the version slug first.

stsewd added a commit to stsewd/readthedocs.org that referenced this issue Sep 24, 2019
Machine created versions aren't allowed to be changed,
since we use their harcoded slug to identify them as latest and stable.

Ref readthedocs#5318
@humitos humitos added the Sprintable Small enough to sprint on label Feb 6, 2020
@helderco
Copy link

This seems like the right fix for my use case, let me know if this is true.

I have a python library in a monorepo with components in other languages. For this library, new versions are released by pushing a new sdk/python/v<semver> tag.

Would this feature allow extracting the semver from the tag and use that? Would it also work to set stable?

@stsewd
Copy link
Member

stsewd commented Nov 14, 2022

This seems like the right fix for my dagger/dagger#3767, let me know if this is true.
Would this feature allow extracting the semver from the tag and use that?

Yes, if implemented, this would solve your problem. Thanks for commenting your use case!

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 Feature New feature Sprintable Small enough to sprint on
Projects
Status: Planned
Development

No branches or pull requests

4 participants