Publish last commit information (#286)

* Trial without conditional run

* Missing "with"

* Better to unify all pre-commit operations in one place

* Bug on configuration key used

* Bug - Add echo in command

* Select files on where to apply pre-commit

* Remove bash -c

* Bash script approach

* Reverting pre-commit approach...

* Commit to your own branch on every push - main branch is protected

* Append last commit information to README (and thus to PKG-INFO)

* LAST_COMMIT Variable creation

* Adapt Makefile

* Doc for global variable

* Modify output way - via method version_info()

* Rename Makefile target from last-commit-info to version-info

* Missing field to adapt

* Single underscore for _VERSION_INFO

* Return __version__ if undefined _VERSION_INFO

* Apply suggestions from code review

Co-authored-by: Jorge Martínez <[email protected]>

* Adding extra line - style check

* Minor modification to NB statement

* Change location

* Remove spaces

Co-authored-by: Jorge Martínez <[email protected]>

Author: RobPasMue

.github/workflows/ci.yml

@@ -181,6 +181,9 @@ jobs:
       - name: Install pyvistaqt requirements
         run: make install-pyvistaqt-requirements
 
+      - name: Add version information
+        run: make version-info
+
       - name: Install pyfluent with post requirements
         run: make install-post
 

Makefile

@@ -8,6 +8,10 @@ install:
 	@python setup.py bdist_wheel
 	@pip install dist/*.whl
 
+version-info:
+	@bash -c "date -u +'Build date: %B %d, %Y %H:%M UTC ShaID: <id>' | xargs -I date sed -i 's/_VERSION_INFO = .*/_VERSION_INFO = \"date\"/g' ansys/fluent/core/__init__.py"
+	@bash -c "git --no-pager log -n 1 --format='%h' | xargs -I hash sed -i 's/<id>/hash/g' ansys/fluent/core/__init__.py"
+
 install-post:
 	@pip install -r requirements_build.txt
 	@python setup.py sdist

README.rst

@@ -98,4 +98,4 @@ to the Fluent without changing the core behavior or license of the original
 software.  The use of the interactive Fluent control of ``PyFluent`` requires a
 legally licensed local copy of Ansys.
 
-To get a copy of Ansys, please visit `Ansys <https://www.ansys.com/>`_.
+To get a copy of Ansys, please visit `Ansys <https://www.ansys.com/>`_.

ansys/fluent/core/__init__.py

@@ -18,6 +18,24 @@
 except ImportError:
     pass
 
+_VERSION_INFO = None
+"""Global variable indicating the version of the PyFluent package - Empty by default"""
+
+
+def version_info():
+    """Method returning the version of PyFluent being used.
+
+    Returns
+    -------
+    str
+        The PyFluent version being used.
+
+    Notes
+    -------
+    Only available in packaged versions. Otherwise it will return __version__.
+    """
+    return _VERSION_INFO if _VERSION_INFO is not None else __version__
+
 
 def set_log_level(level):
     """Set logging level.