Skip to content

Follow semantic versioning (version X.Y.Z) #629

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
GuillemBarroso opened this issue Nov 19, 2022 · 6 comments
Closed

Follow semantic versioning (version X.Y.Z) #629

GuillemBarroso opened this issue Nov 19, 2022 · 6 comments

Comments

@GuillemBarroso
Copy link
Contributor

The syntax for this version does not follow semantic versioning, see dev guide. We should open an issue to address this in a separate pull-request, @GuillemBarroso. I know it was originally defined like this in the setup.py.

Originally posted by @jorgepiloto in #627 (comment)

@PProfizi
Copy link
Contributor

Hi @GuillemBarroso, hi @jorgepiloto, I am not sure I understand the problem with having our master as X.Y.Z.devA.
This follows normalized semantic versioning as stated here.

@GuillemBarroso
Copy link
Contributor Author

Hi @PProfizi,

@jorgepiloto, correct me if I am wrong, but what I understood form the developers guide is that the agreed convention is:

  • main branch: The version will always be X.Y.dev0.
  • release branches: The versions here will be X.Y.Z

meaning that the minor patch number (Z) for main branch is always dev0.

@PProfizi
Copy link
Contributor

PProfizi commented Nov 21, 2022

@GuillemBarroso
For PyDPF packages, we are currently working with a "0.X.Y" format, so our third number should not be understood as "patch" but really as minor. Hence, the "0.X.Y.devA".
The reason behind keeping the first number at 0 is historical, it might change in the future.
This might not be exactly like the pyansys guidelines yet this is semantically correct.

I think this issue can be closed as not planned.

@GuillemBarroso
Copy link
Contributor Author

Thank you for the clarification @PProfizi.

@jorgepiloto, do you think we are going to run into some issues when integrating the pyansys/actions in PyDPF-Core?

@jorgepiloto
Copy link
Member

I was too fast opening this issue, sorry for this. @PProfizi is right. This version follows semantic versioning, so this issue can be closed.

However, I would encourage to follow the "X.Y.dev0" for main, as this is what is being done by other libraries like PyMAPDL or PyAEDT.

@GuillemBarroso
Copy link
Contributor Author

Thanks @jorgepiloto. Closing this issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants