[build] Dependabot upgrades for Antlr crash the build.

antlr / grammars-v4

Grammars written for ANTLR v4; expectation that the grammars are free of actions.

MIT License

10.15k stars 3.7k forks source link

[build] Dependabot upgrades for Antlr crash the build. #3468

Closed kaby76 closed 1 year ago

kaby76 commented 1 year ago

When Antlr is released, Github offers dependabot updates to upgrade some of the targets. Unfortunately, these updates can crash the build because of some assumptions:

The Antlr tool version is a separate update from the runtime version update. When dependabot updates the runtime version, it has no clue that the Antlr tool version also needs to be updated.
All targets use the same version of the tool.

To streamline updating to the next version of Antlr, the version of the tool should be derived from the version of the runtime, thus allowing dependabot updates to work.

Dependabot will update JavaScript, Python3, maven-source-plugin, and the root pom.xml (which really isn't used).

This means each target will be on its own version of Antlr. That's probably best because the Dart and PHP runtimes aren't released promptly. They usually take weeks because I have to ask people to cut a release and push it to public servers.

kaby76 commented 1 year ago

https://github.com/antlr/grammars-v4/pull/3467

kaby76 commented 1 year ago

So, let's analyse each of the targets and see how an Antlr upgrade is handled.

CSharp. The version of Antlr used is the version selected in the .csproj. https://github.com/antlr/grammars-v4/blob/4d7389ea494054dd952cfc6cd946b61e16de1679/_scripts/templates/CSharp/Test.csproj#L15. There's a bit of code to use a specific version of the tool, https://github.com/antlr/grammars-v4/blob/4d7389ea494054dd952cfc6cd946b61e16de1679/_scripts/templates/CSharp/Test.csproj#L11, but that should be removed. The build is accomplished by Antlr4BuildTasks, which downloads the JRE and the Antlr tool needed based on the version set for the runtime.

kaby76 commented 1 year ago

Dart. The version of Antlr used is set here. We just need to extract the version out of the .yaml file, and make sure to use antlr4 with that version.

kaby76 commented 1 year ago

Java. Right now, we don't use an integrated tool like maven to set the version. That should probably be fixed. Otherwise, we need to set the version in the two build scripts here. https://github.com/antlr/grammars-v4/blob/65556f3d8adcf84900bbb14c1dd4c40b7db9996c/_scripts/templates/Java/build.sh https://github.com/antlr/grammars-v4/blob/65556f3d8adcf84900bbb14c1dd4c40b7db9996c/_scripts/templates/Java/build.ps1

kaby76 commented 1 year ago

Cpp. The version is set here. But, the problem is not over because it doesn't call the antlr4-tools "antlr4" tool. https://github.com/antlr/grammars-v4/blob/65556f3d8adcf84900bbb14c1dd4c40b7db9996c/_scripts/templates/Cpp/cmake/antlr4-generator.cmake.in#LL146C16-L146C16. That code needs to change.