Publish version to within fpm #865

perazz · 2023-04-03T11:11:14Z

Addressing #855: for metapackages and registry handling, fpm must know what version is running.

I think there are two main ways of doing this:

pass it via a pre-processor flag
read a generic external file
pass it via a fortran include file.

In both cases, a CI script needs to keep this version up to date.

I like option 3) better because it's not compiler dependent, and once the repo is deployed, there's no way to change it, it's inside the source code. So here's what I think may work:

Extract version from git in the wake of what LFortran does: 09d09e1
Have all fpm include files inside include/, so they're excluded from the build: c9a35da
I think none of these parameters should be public, just operate with version_t within fpm 44b0a2a

If there's consensus on this way forward @certik @awvwgk @urbanjost @fortran-lang/admins, please let me know and I can complete the CI and the tests! I would then address fpm version requirements as a separate PR.

cc: @arteevraina @henilp105 @minhqdao

perazz · 2023-04-06T08:18:30Z

include files are not supported by the CI when it builds a single-file source of fpm. The solution is nontrivial so I've changed the CI script to create a full Fortran module file where all CI-based parameters will be stored. Looks much better IMHO.

src/fpm/fpm_release_parameters.f90

awvwgk

I strongly believe that this is not the way to go. To export the version from the from must not rely on an external script, rather fpm should support generating a module like this intrinsically.

perazz · 2023-04-06T20:10:53Z

I understand @awvwgk, what is your piece of advice? You mean fpm should generate that module file and add it somewhere as a dependency to the child fpm build? That's of course feasible, maybe easier than with a bash script, but it would have to read the version and commit ID starting from a CI variable or pre-processing script anyways?

awvwgk · 2023-04-06T20:45:41Z

That's probably a longer discussion. To export the version from only needs to know the manifest and we already have a preprocess table to forward a version number macro. Generally I don't see any good reason to pick up the version number from a VCS tag, stuff like setuptools-scm introduce quite some edge cases in the Python ecosystem already.

perazz · 2023-04-07T07:30:56Z

fpm.toml

+[preprocess]
+[preprocess.cpp]
+macros=["FPM_VERSION={version}"]
+


The following update passes version from the manifest into fpm as a preprocessed macro @awvwgk. I like this way, but it cannot be built (fpm 0.3.0 used for bootstrapping). Should we update fpm to 0.7.0 in the bootstrapping action?

perazz · 2023-04-07T08:04:00Z

@awvwgk It seems like fpm cannot be bootstrap with fpm-0.7.0 release: the CI crashes due to bug #803 in pre-processing flags which also exists in latest. One option would be to setup the fpm-setup action with a more recent build, but that is very strongly discouraged IMHO

awvwgk · 2023-04-07T08:17:09Z

Then let's make a new release 0.7.1 which picks the bugfix or a new feature release 0.8.0

perazz · 2023-04-07T14:05:24Z

.github/workflows/release.yml

+        echo ${{ env.VERSION }}
+
+    - name: Get manifest version
+      run: |
+        MANIFEST_VERSION=$(grep version fpm.toml | head -1 | tr -d ' ' | tr -d 'version=')
+        echo "MANIFEST_VERSION=${MANIFEST_VERSION}" >> $GITHUB_ENV
+        echo ${{ env.MANIFEST_VERSION }}


Using pre-processing flags, there are a couple more steps with the single-file-version:

the single-source-file version is not built with fpm, so we need to first query the manifest version into a variable,

perazz · 2023-04-07T14:06:51Z

.github/workflows/release.yml

+        # We need to pass the exact version string that a fpm build command would send
+        echo "#define FPM_RELEASE_VERSION ${{ env.MANIFEST_VERSION }}" > fpm-${{ env.VERSION }}.F90


manually set a preprocessor flag.

perazz · 2023-04-07T14:11:37Z

src/fpm/fpm_release.f90

+        ! Accept solution from https://stackoverflow.com/questions/31649691/stringify-macro-with-gnu-gfortran
+        ! which provides the "easiest" way to pass a macro to a string in Fortran complying with both
+        ! gfortran's "traditional" cpp and the standard cpp syntaxes
+
+#ifndef FPM_RELEASE_VERSION
+#  define FPM_RELEASE_VERSION UNDEFINED
+#endif
+
+#ifdef __GFORTRAN__ /* traditional-cpp stringification */
+#  define STRINGIFY_START(X) "&
+#  define STRINGIFY_END(X) &X"
+#else               /* default stringification */
+#  define STRINGIFY_(X) #X
+#  define STRINGIFY_START(X) &
+#  define STRINGIFY_END(X) STRINGIFY_(X)
+#endif
+
+        character (len=:), allocatable :: ver_string
+        ver_string = STRINGIFY_START(FPM_RELEASE_VERSION)
+        STRINGIFY_END(FPM_RELEASE_VERSION)


Finally, gfortran needs some pretty verbose preprocessing, even just to pass along a string, because it uses the "traditional" version of the cpp preprocessor

…into publish_version_to_fpm

perazz · 2023-04-07T14:40:51Z

I believe this is completed. @henilp105 @arteevraina @minhqdao @awvwgk @certik if any of you needs this merged before the weekend, please review it and do it yourself, I'll be back on Tuesday. Happy Easter!

Requested changes are made

henilp105

Thanks @perazz , Looks good to me.

perazz · 2023-04-13T10:25:23Z

I would like to merge this one so we can publish the fpm version to the model dump (#879). I will wait another day or so and if there are no further requests, will go ahead and merge.

perazz · 2023-04-14T11:09:42Z

Thank you @henilp105, I will merge this one.

perazz added 7 commits April 3, 2023 12:52

Version file generation script

09d09e1

add include/ folder to fpm manifest

c9a35da

add dummy version file

f37e9f1

create a release_parameters module

44b0a2a

test fpm can query its version

642fbb5

replace include file with an actual Fortran module

ccf8496

fpm: replace included file with the module reference

a0909c1

clean CI script

91d52b5

perazz requested review from awvwgk, arteevraina, certik, henilp105 and minhqdao April 6, 2023 18:39

awvwgk previously requested changes Apr 6, 2023

View reviewed changes

perazz added 2 commits April 7, 2023 09:19

replace bash script with manifest macro

a4f2e1a

keep version in fpm --version updated

168331f

perazz commented Apr 7, 2023

View reviewed changes

perazz added 5 commits April 7, 2023 09:41

bump bootstrapper to 0.7.0

f0fa518

bump bootstrapper to 0.7.0 in release

69626fe

conflict: rename macro to FPM_RELEASE_VERSION

25c359e

move preprocess up

9c853f5

add verbosity

b3e1327

perazz added 3 commits April 7, 2023 10:24

update bootstrapping version to 0.8.0

87ac559

Merge branch 'main' into publish_version_to_fpm

23fc2e9

update version_t api

99fde02

perazz added 9 commits April 7, 2023 15:20

pass macro via traditional-cpp (gfortran)

e2f8aab

fix ver_string

ccf98cb

remove tests from manifest

1a4048f

restore tests; update single-file patch

c274c68

restore tests

497e43d

add verbose to release CI

30ee359

single-file build is not made with fpm! pass macro manually

d494c09

pass version via macro

5c3c001

Update release CI with manifest version

5670355

perazz commented Apr 7, 2023

View reviewed changes

perazz added 4 commits April 7, 2023 16:18

fix typo

c6cfc5e

cleanup: remove --verbose flags

ee473ee

Merge branch 'publish_version_to_fpm' of https://github.com/perazz/fpm …

d150263

…into publish_version_to_fpm

fallback to a known version if catastrophic error

d95cf15

henilp105 approved these changes Apr 9, 2023

View reviewed changes

Merge branch 'main' into publish_version_to_fpm

ef49e49

perazz merged commit 70e32c9 into fortran-lang:main Apr 14, 2023

perazz deleted the publish_version_to_fpm branch April 14, 2023 11:10

This was referenced Apr 19, 2023

Can't build fpm #884

Closed

Extract version reading #885

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Publish version to within fpm #865

Publish version to within fpm #865

Uh oh!

perazz commented Apr 3, 2023 •

edited

Loading

Uh oh!

perazz commented Apr 6, 2023

Uh oh!

awvwgk left a comment

Uh oh!

perazz commented Apr 6, 2023 •

edited

Loading

Uh oh!

awvwgk commented Apr 6, 2023

Uh oh!

perazz Apr 7, 2023

Uh oh!

perazz commented Apr 7, 2023 •

edited

Loading

Uh oh!

awvwgk commented Apr 7, 2023

Uh oh!

perazz Apr 7, 2023 •

edited

Loading

Uh oh!

perazz Apr 7, 2023 •

edited

Loading

Uh oh!

perazz Apr 7, 2023

Uh oh!

perazz commented Apr 7, 2023

Uh oh!

henilp105 left a comment

Uh oh!

perazz commented Apr 13, 2023

Uh oh!

perazz commented Apr 14, 2023

Uh oh!

Uh oh!

		# We need to pass the exact version string that a fpm build command would send
		echo "#define FPM_RELEASE_VERSION ${{ env.MANIFEST_VERSION }}" > fpm-${{ env.VERSION }}.F90

Publish version to within fpm #865

Publish version to within fpm #865

Uh oh!

Conversation

perazz commented Apr 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

perazz commented Apr 6, 2023

Uh oh!

awvwgk left a comment

Choose a reason for hiding this comment

Uh oh!

perazz commented Apr 6, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

awvwgk commented Apr 6, 2023

Uh oh!

perazz Apr 7, 2023

Choose a reason for hiding this comment

Uh oh!

perazz commented Apr 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

awvwgk commented Apr 7, 2023

Uh oh!

perazz Apr 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

perazz Apr 7, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

perazz Apr 7, 2023

Choose a reason for hiding this comment

Uh oh!

perazz commented Apr 7, 2023

Uh oh!

henilp105 left a comment

Choose a reason for hiding this comment

Uh oh!

perazz commented Apr 13, 2023

Uh oh!

perazz commented Apr 14, 2023

Uh oh!

Uh oh!

perazz commented Apr 3, 2023 •

edited

Loading

perazz commented Apr 6, 2023 •

edited

Loading

perazz commented Apr 7, 2023 •

edited

Loading

perazz Apr 7, 2023 •

edited

Loading

perazz Apr 7, 2023 •

edited

Loading