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

Automation rule that hides previous fix version #11556

Open
andy-maier opened this issue Aug 21, 2024 · 0 comments
Open

Automation rule that hides previous fix version #11556

andy-maier opened this issue Aug 21, 2024 · 0 comments
Labels
Feature New feature Needed: design decision A core team decision is required

Comments

@andy-maier
Copy link

andy-maier commented Aug 21, 2024

What's the problem this feature will solve?

In projects that use semver, a new fix version is meant to replace the previous fix version (of the same major and minor version). This can be used to reduce the number of versions shown in the version selection pane, by hiding the previous fix version if a new fix version != 0 is created.

For example, in our https://github.com/zhmcclient/python-zhmcclient/ project, we currently have a total of 51 tags with versions >=1.0.0, but only 18 tags for the latest fix version (within a particular major and minor version).

So this allows us to reduce the number of versions shown from 51 to 18, without loosing anything.

Describe the solution you'd like

The feature I'm asking for is to support an automation rule that allows hiding the previous fix version (within the same major and minor version) if a new fix version is created. Current automation rules only allow hiding the matching version, but not any other version.

Alternative solutions

Hiding the version through the "Version update" call at the RTD REST API (https://docs.readthedocs.io/en/stable/api/v3.html#version-update) might be an alternative, but that requires the GitHub workflow to have RTD API access, and an RTD automation would be more elegant.

A more comfortable way for GitHub Actions workflow to call the API would be an action that encapsulates that. See readthedocs/actions#44 for that.

Manually hiding the prior fix version is what we currently do, but that requires users to have RTD access, and is a manual step we'd like to automate.

Additional context

python-zhmcclient project:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New feature Needed: design decision A core team decision is required
Projects
None yet
Development

No branches or pull requests

2 participants