There should be single source of truth for the project version

[damccorm]

Now the Beam version is defined in two places:

• via the 'version' parameter in gradle.properties,
• programmatically in the apply function in BeamModulePlugin

The latter effectively overrides the former. For someone not very familiar with the Beam build system this may result in a hard to understand and debug behavior: unexpected version gets build and/or pushed to local Maven repository, and changing version in gradle.properties does not have any effect.

Adding a comment with a reference to BeamModulePlugin to gradle.properties can be a good start, and in the long run it would be great to have single source of truth for the project version.

 

 

Imported from Jira BEAM-14051. Original Jira may contain additional context.
Reported by: dmitryor.

[zjffdu]

@damccorm IIUC, if I just want to build a snapshot version on the master branch, I don't need to change anything in BeamModulePlugin and gradle.properties, is that right?

[damccorm]

Yeah, that should be right

[kennknowles]

I don't know how I did not know about this. Sheesh.

[kennknowles]

Is "choose_rc_commit.sh" broken? Answer is "sort of". Yea why in the world does BeamModulePlugin do this.

[kennknowles]

It is actually defined in 6 places:

beam/release/src/main/scripts/set_version.sh

Line 74 in 8031162

sed -i -e "s/version=.*/version=$TARGET_VERSION/" gradle.properties

Some of this is "essential" because Go and Python have a different concept for non-release versions than Java does. But I'm at least going to resolve the specific redundancy here which causes spurious -SNAPSHOT added when the source of truth should suffice for that determination.

[Naireen]

Is this stale? I no longer see the version explicitly mentioned in BeamModulePluginGroovy (seems to have dissapeared between version 2.51 and 2.52.)

[kennknowles]

I got rid of at least one. I think there are probably still a few. I guess I would want to check all the places that https://github.com/apache/beam/blob/master/release/src/main/scripts/set_version.sh sets things. This script may be obsoleted by some new GitHub Actions. (the only purpose the script really has is to know all the places the version exists)