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

fix: allow for missing patch number in tag when deploying docs #653

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

RobPasMue
Copy link
Member

Following discussion on dev meeting - tags missing patch number should also be accepted for deploying stable docs since it isn't necessary to have them

@ansys-reviewer-bot
Copy link
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@RobPasMue RobPasMue self-assigned this Nov 29, 2024
@RobPasMue RobPasMue marked this pull request as ready for review November 29, 2024 15:47
@RobPasMue RobPasMue requested a review from a team as a code owner November 29, 2024 15:47
@github-actions github-actions bot added the fix Pull requests related to resolving problems or errors label Nov 29, 2024
@SMoraisAnsys
Copy link
Contributor

Following discussion on dev meeting - tags missing patch number should also be accepted for deploying stable docs since it isn't necessary to have them

That might be a dumb question but why are we allowing versions that don't follow X.Y.Z template ?
Are maintainers following that approach only releasing minor releases or do they expect to also release patch releases ? If it's the latter, I'm a bit confused as of how this will end up in pypi or github releases.

@RobPasMue
Copy link
Member Author

Following discussion on dev meeting - tags missing patch number should also be accepted for deploying stable docs since it isn't necessary to have them

That might be a dumb question but why are we allowing versions that don't follow X.Y.Z template ? Are maintainers following that approach only releasing minor releases or do they expect to also release patch releases ? If it's the latter, I'm a bit confused as of how this will end up in pypi or github releases.

According to our actions, we were allowing them previously. We can remove this behavior altogether as well, but there's nothing preventing a user from creating a tag "v0.8" and pushing it to PyPI without a patch number. Not ideal, but nothing preventing you from doing it either.

We can discuss this further on Thursday if you prefer.

@SMoraisAnsys
Copy link
Contributor

Following discussion on dev meeting - tags missing patch number should also be accepted for deploying stable docs since it isn't necessary to have them

That might be a dumb question but why are we allowing versions that don't follow X.Y.Z template ? Are maintainers following that approach only releasing minor releases or do they expect to also release patch releases ? If it's the latter, I'm a bit confused as of how this will end up in pypi or github releases.

According to our actions, we were allowing them previously. We can remove this behavior altogether as well, but there's nothing preventing a user from creating a tag "v0.8" and pushing it to PyPI without a patch number. Not ideal, but nothing preventing you from doing it either.

We can discuss this further on Thursday if you prefer.

I don't think I'll be able to join on Thursday (I'm getting back from travel) but that's a subject that should be clarified yeah. I'd rather have no X.Y version and only X.Y.Z versions.

Copy link
Contributor

@SMoraisAnsys SMoraisAnsys left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Taking the liberty to "block" this PR as long as the dicussion on releasing minor versions is not clarified

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fix Pull requests related to resolving problems or errors
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants