Add Versioning Support from `version.txt` #3140

ahnaf-tahmid-chowdhury · 2024-09-24T06:28:42Z

Overview

This pull request introduces a versioning mechanism that utilizes a version.txt file located in the tools folder. Both pyproject.toml and CMakeLists.txt have been updated to read version information from this file, ensuring consistency across the project.

Changes

Added version.txt: A new file in the tools directory containing the version string in the format X.X.X or X.X.X-any.
Updated pyproject.toml:
- The version field in pyproject.toml is now set to read the version from version.txt. This enables automatic versioning based on the contents of version.txt.
Updated CMakeLists.txt:
- The CMake configuration has been modified to read the version from version.txt and set the OPENMC_VERSION accordingly.
- Implemented logic to handle versions with optional suffixes (e.g., -dev, -any), ensuring that the header files use only the main version number without the suffix.

Benefits

Consistency: Centralizing version information in a single file (version.txt) ensures that both Python and CMake projects remain in sync.
Flexibility: The version can be easily updated by modifying just one file, simplifying version management.

Fixs

Create single source of truth for version identifier #3136

ahnaf-tahmid-chowdhury · 2024-09-24T13:38:40Z

Not sure how to resolve this

ERROR: THESE PACKAGES DO NOT MATCH THE HASHES FROM THE REQUIREMENTS FILE. 
If you have updated the package versions, please update the hashes. Otherwise, 
examine the package contents carefully; someone may have tampered with them.
unknown package:
    Expected sha256 f728bb61f43fce850d622ced3b3d51b3116f767685ca4e4e0076f624e2d2307d
         Got        afe0e1873a0a0858a245ccd771066eddc07d20068859f1dd669a002e5dc68a65

shimwell · 2024-09-26T14:59:47Z

pyproject.toml

@@ -58,6 +58,9 @@ Documentation = "https://docs.openmc.org"
 Repository = "https://github.com/openmc-dev/openmc"
 Issues = "https://github.com/openmc-dev/openmc/issues"

+[tool.setuptools.dynamic]
+version = {file = "tools/version.txt"}


Does this file need locating elsewhere, perhaps in the source code. I'm not sure but perhaps that helps when packaging as I don't think the tools folder is included in the packaging (e.g. conda)

This file is only required at build time. If it is necessary at runtime, we can put it in the root dir.

It appears that openmc-feedstock uses a specific release tar file, which includes all the folders, including the tools folder.

Thanks for answering this

I'm not an expert, but this doesn't feel like a tools sort of thing. To me it feels like a top level file.

Doing it this way means openmc.__version__ still works due to how __version__ is populated.

I have stored this file in the tools directory because it is only required during build time. Python's wheel uses it to create the wheel, and CMake uses it to generate the version.h file. Additionally, we can use this file for other purposes. I placed it in that folder to keep the root directory clean. However, if necessary, we can move it to the root directory.

I tend to agree that this is more of a root-level file.

shimwell · 2024-09-26T16:48:07Z

The CI passed when I rerun a single job just now. So I have re triggered the others and I guess it will pass now. I think the previous failure was unrelated to this CI

shimwell · 2024-09-26T21:00:11Z

CI is all green 🎉

Do you think it is worth adding a version test to the pytests, perhaps something like this
https://github.com/fusion-energy/cad_to_dagmc/blob/main/tests/test_version.py

ahnaf-tahmid-chowdhury · 2024-09-27T01:33:53Z

I have already added something similar to this in the CMakeLists.txt, which will perform a similar task during configuration. I am also using setuptools to get the version number on the Python side, which will cause an error if an improper format is set.

shimwell · 2024-09-27T11:15:21Z

This looks good to me, does anyone else want to take a peak. Perhaps @MicahGale

MicahGale

Design looks good. However this doesn't seem to be propagating to the C++ side properly in my testing.

I followed the build from source method cmake .. && make. However build/bin/openmc -v was still showing openmc version 0.15.0.

MicahGale · 2024-09-27T13:44:59Z

pyproject.toml

@@ -58,6 +58,9 @@ Documentation = "https://docs.openmc.org"
 Repository = "https://github.com/openmc-dev/openmc"
 Issues = "https://github.com/openmc-dev/openmc/issues"

+[tool.setuptools.dynamic]
+version = {file = "tools/version.txt"}


I'm not an expert, but this doesn't feel like a tools sort of thing. To me it feels like a top level file.

MicahGale · 2024-09-27T13:46:56Z

tools/version.txt

@@ -0,0 +1 @@
+1.15.1-dev


This is probably beyond the scope of this PR alone, but this isn't PyPA compliant. It should be: 0.15.1.devN (Probably dev1?). Also you accidentally incremented a major release.

Setuptools will handle the task for us, so we can continue using the legacy format.

This is something setuptools does because it's nice to do; not because it has to. I think changing to PyPA compliant is a small change that would reduce the risk of something breaking in the future. (Honestly I don't think many people would even notice beyond some of the core devs.)

PyPA does allow -dev but probably better to use a dot since it's perferred

Thanks. TIL.

MicahGale · 2024-09-27T13:58:26Z

pyproject.toml

@@ -58,6 +58,9 @@ Documentation = "https://docs.openmc.org"
 Repository = "https://github.com/openmc-dev/openmc"
 Issues = "https://github.com/openmc-dev/openmc/issues"

+[tool.setuptools.dynamic]
+version = {file = "tools/version.txt"}


Doing it this way means openmc.__version__ still works due to how __version__ is populated.

ahnaf-tahmid-chowdhury · 2024-09-27T14:35:54Z

I followed the build from source method cmake .. && make. However build/bin/openmc -v was still showing openmc version 0.15.0.

It seems you have an old version of openmc installed. And you have exported that on your PATH. You can easily review it by calling

which openmc

MicahGale · 2024-09-27T14:46:30Z

I followed the build from source method cmake .. && make. However build/bin/openmc -v was still showing openmc version 0.15.0.

It seems you have an old version of openmc installed. And you have exported that on your PATH. You can easily review it by calling
which openmc

Oh yep that was my issue. I'm used to python where $PATH does not shadow the current directory.

pshriwise

Adding a suggestion for convenience.

tools/version.txt

pshriwise · 2024-09-27T15:26:28Z

pyproject.toml

@@ -58,6 +58,9 @@ Documentation = "https://docs.openmc.org"
 Repository = "https://github.com/openmc-dev/openmc"
 Issues = "https://github.com/openmc-dev/openmc/issues"

+[tool.setuptools.dynamic]
+version = {file = "tools/version.txt"}


I tend to agree that this is more of a root-level file.

paulromano

A few immediate thoughts:

Some people argue that you shouldn't store version information in files in the first place. If there's a way we can do this that automatically pulls information from git, that would probably be better.
If we do go with what you have here, there's one more instance of hardcoding of the version in docs/source/conf.py.

MicahGale · 2024-09-27T15:49:58Z

Some people argue that you shouldn't store version information in files in the first place. If there's a way we can do this that automatically pulls information from git. If that case can be addressed I really prefer using git tag.

@paulromano: @gonuke brought up some good points, that there are use cases for when the source code may be used while detached from git. I'm not sure right now of a work-around for that case using git based methods, which I generally agree would be the ideal solution.

If we do go with what you have here, there's one more instance of hardcoding of the version in docs/source/conf.py.

I'd recommend that @ahnaf-tahmid-chowdhury go with using a importlib.... call in this file no matter what because that will be agnostic to however python retrieves version information.

ahnaf-tahmid-chowdhury · 2024-09-27T16:12:38Z

I have added the get_version_info function to extract the version info, but I am unsure what working directory Read the Docs is using. For now, I am assuming it is using docs/source/ as the working directory.

Recently, I noticed @MicahGale's comment on this. We can use importlib, but again, I need to understand how Read the Docs processes this. If it runs the conf.py file before installing OpenMC, it will fail.

ahnaf-tahmid-chowdhury · 2024-09-27T16:49:52Z

It seems docs buils are passing https://readthedocs.org/projects/openmc/builds/25766475/

We can use importlib.metadata.version, but we still need to use the get_version_info function as there are two var.

gonuke · 2024-10-08T00:53:44Z

Some people argue that you shouldn't store version information in files in the first place. If there's a way we can do this that automatically pulls information from git, that would probably be better.

We definitely came here, @paulromano , to get broader perspective on this issue. I definitely like the elegance of git being a single source of truth, but worry about folks who build from tarballs (e.g. those generated automatically by GitHub upon release) rather than clones. Do we ignore them? Or do we find a way to make that work, too?

MicahGale · 2024-10-08T01:06:13Z

@gonuke one thing I thought about is that setuptools-scm will create a _version.py file. As part of the GH release process a source tar ball with a version file could be included. I think building from a source tar ball for a specific release would be a lot more common than from a specific branch.

ahnaf-tahmid-chowdhury · 2024-10-08T14:28:38Z

An additional note: If we use setuptools-scm, when someone installs OpenMC from a tarball, it will build a version labeled 0.0.0.

MicahGale · 2024-10-08T15:02:12Z

@ahnaf-tahmid-chowdhury Good point. Do you want to try and see if we could make a CI release that would embed a version file in a release tar ball from setuptools-scm?

ahnaf-tahmid-chowdhury · 2024-10-08T15:19:27Z

For this, we may need to use a workflow to build OpenMC that will create the version file. Once done, it will push the updated commit to the develop branch. We can use any existing workflow, like this one, and it will only run if the PR gets merged. Let me know if I should proceed with that approach.

MicahGale · 2024-10-08T16:03:30Z

No this is a bad idea. _version.py should never be in git. What I was thinking was as part of the release process having python -m build . create the version file. Create a complete source tar ball which include _version.py and then upload that to the GH release as an artifact.

ahnaf-tahmid-chowdhury · 2024-10-08T17:17:43Z

We are currently working on PR #3087, which will create wheel (.whl) artifacts after a release. Your approach is good, but GitHub automatically creates its own tarball with each release. So, in the end, we will be releasing multiple tarballs. And, I am unfamiliar with resolving that.

gonuke

A little typo....?

cmake/Modules/GetVersionFromGit.cmake

Co-authored-by: Paul Wilson <paul.wilson@wisc.edu>

paulromano

Thanks for all the work put into this @ahnaf-tahmid-chowdhury!

paulromano · 2025-02-20T19:51:42Z

@pshriwise @gonuke @MicahGale are you all on board for merging this PR?

MicahGale

I verified that git_archival.txt still works with setuptools_scm, which is done. Let's ship this!

gonuke

A couple of final little comments...

cmake/Modules/GetVersionFromGit.cmake

Co-authored-by: Ahnaf Tahmid Chowdhury <ahnaf-tahmid@outlook.com>

gonuke

This looks good to me - thanks @ahnaf-tahmid-chowdhury for your work on this, looking forward to translating it to other projects

ahnaf-tahmid-chowdhury · 2025-02-22T06:32:54Z

I just noticed that the Dockerfile is failing because it runs git clone with the --depth 1 option. We could add a method in the CMake file to fetch everything, but I wonder how setuptools_scm will handle that in the future when we switch to scikit-build-core. Or, we might consider removing the --depth option.

single source of truth for version identifier

5779779

shimwell reviewed Sep 26, 2024

View reviewed changes

shimwell approved these changes Sep 27, 2024

View reviewed changes

MicahGale suggested changes Sep 27, 2024

View reviewed changes

MicahGale mentioned this pull request Sep 27, 2024

Update guidance on build from source to retrieve python dependencies #3146

Open

pshriwise requested changes Sep 27, 2024

View reviewed changes

paulromano requested changes Sep 27, 2024

View reviewed changes

ahnaf-tahmid-chowdhury added 2 commits September 27, 2024 21:31

Follow PyPA compliant

104dfb0

move version file to root-level

cb849ee

add get_version_info function

0ce318c

ahnaf-tahmid-chowdhury requested a review from paulromano September 27, 2024 16:50

Merge remote-tracking branch 'upstream/develop' into version

0eff6a4

ahnaf-tahmid-chowdhury requested a review from pshriwise October 5, 2024 17:45

ahnaf-tahmid-chowdhury added 3 commits January 27, 2025 01:35

Move versioning to a separate file, as suggested by @gonuke

21594d6

add more info

14e678f

Merge remote-tracking branch 'upstream/develop' into version

075f92b

gonuke suggested changes Jan 27, 2025

View reviewed changes

cmake/Modules/GetVersionFromGit.cmake Outdated Show resolved Hide resolved

cmake/Modules/GetVersionFromGit.cmake Outdated Show resolved Hide resolved

cmake/Modules/GetVersionFromGit.cmake Outdated Show resolved Hide resolved

ahnaf-tahmid-chowdhury and others added 3 commits January 27, 2025 20:27

Update cmake/Modules/GetVersionFromGit.cmake

dc28e2a

Co-authored-by: Paul Wilson <paul.wilson@wisc.edu>

Update cmake/Modules/GetVersionFromGit.cmake

e2a64d7

Co-authored-by: Paul Wilson <paul.wilson@wisc.edu>

add more variables

1603dc5

ahnaf-tahmid-chowdhury force-pushed the version branch from 98584de to 1603dc5 Compare January 27, 2025 18:05

Update cmake/Modules/GetVersionFromGit.cmake

9dc344e

Co-authored-by: Paul Wilson <paul.wilson@wisc.edu>

ahnaf-tahmid-chowdhury requested a review from jtramm as a code owner February 6, 2025 16:31

ahnaf-tahmid-chowdhury force-pushed the version branch from 31a7f69 to 9dc344e Compare February 17, 2025 17:37

ahnaf-tahmid-chowdhury and others added 4 commits February 18, 2025 00:12

Merge branch 'develop' into version

efc43ba

Don't use PROJECT_ variable names

a2942f6

Get rid of unused variables

727a0ae

Fix fetch-depth

8440b2c

paulromano approved these changes Feb 20, 2025

View reviewed changes

Set fetch-depth to 0 as before

8ddcb06

MicahGale approved these changes Feb 20, 2025

View reviewed changes

gonuke suggested changes Feb 21, 2025

View reviewed changes

cmake/Modules/GetVersionFromGit.cmake Show resolved Hide resolved

cmake/Modules/GetVersionFromGit.cmake Outdated Show resolved Hide resolved

ahnaf-tahmid-chowdhury commented Feb 21, 2025

View reviewed changes

cmake/Modules/GetVersionFromGit.cmake Outdated Show resolved Hide resolved

Update cmake/Modules/GetVersionFromGit.cmake

ece247a

Co-authored-by: Ahnaf Tahmid Chowdhury <ahnaf-tahmid@outlook.com>

paulromano added this to the v0.15.1 milestone Feb 21, 2025

pshriwise approved these changes Feb 21, 2025

View reviewed changes

gonuke approved these changes Feb 21, 2025

View reviewed changes

paulromano merged commit a2a5c2a into openmc-dev:develop Feb 21, 2025
16 checks passed

This was referenced Feb 24, 2025

Create single source of truth for version identifier #3136

Closed

Migrate to pyproject.toml #2907

Closed

paulromano mentioned this pull request Mar 7, 2025

Release notes for 0.15.1 #3340

Merged

5 tasks

		@@ -0,0 +1 @@
		1.15.1-dev

Add Versioning Support from version.txt #3140

Add Versioning Support from version.txt #3140

Conversation

ahnaf-tahmid-chowdhury commented Sep 24, 2024

Overview

Changes

Benefits

Fixs

ahnaf-tahmid-chowdhury commented Sep 24, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

shimwell commented Sep 26, 2024

shimwell commented Sep 26, 2024 • edited Loading

ahnaf-tahmid-chowdhury commented Sep 27, 2024

shimwell commented Sep 27, 2024

MicahGale left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ahnaf-tahmid-chowdhury commented Sep 27, 2024

MicahGale commented Sep 27, 2024

pshriwise left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

paulromano left a comment

Choose a reason for hiding this comment

MicahGale commented Sep 27, 2024 • edited Loading

ahnaf-tahmid-chowdhury commented Sep 27, 2024

ahnaf-tahmid-chowdhury commented Sep 27, 2024

gonuke commented Oct 8, 2024

MicahGale commented Oct 8, 2024

ahnaf-tahmid-chowdhury commented Oct 8, 2024

MicahGale commented Oct 8, 2024

ahnaf-tahmid-chowdhury commented Oct 8, 2024

MicahGale commented Oct 8, 2024

ahnaf-tahmid-chowdhury commented Oct 8, 2024

gonuke left a comment

Choose a reason for hiding this comment

paulromano left a comment

Choose a reason for hiding this comment

paulromano commented Feb 20, 2025

MicahGale left a comment

Choose a reason for hiding this comment

gonuke left a comment

Choose a reason for hiding this comment

gonuke left a comment

Choose a reason for hiding this comment

ahnaf-tahmid-chowdhury commented Feb 22, 2025

Add Versioning Support from `version.txt` #3140

Add Versioning Support from `version.txt` #3140

shimwell commented Sep 26, 2024 •

edited

Loading

MicahGale commented Sep 27, 2024 •

edited

Loading