Reintroduce engine get client version v1 with commit in manifest #7548
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…e caclulateVersion (hyperledger#7537)" This reverts commit a8bbcd5. Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
…ommit-in-manifest Signed-off-by: Matilda-Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
This reverts commit f855091 Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
…Version back to original spec Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
Signed-off-by: Matilda Clerke <matilda.clerke@consensys.net>
|
Note: CHANGELOG.md may need to be updated if this is merged after the next release |
garyschulte
reviewed
Aug 30, 2024
| @@ -22,7 +22,8 @@ jar { | |||
| 'Specification-Title': archiveBaseName, | |||
| 'Specification-Version': project.version, | |||
| 'Implementation-Title': archiveBaseName, | |||
| 'Implementation-Version': calculateVersion() | |||
| 'Implementation-Version': calculateVersion(), | |||
| 'Commit-Hash': getGitCommitDetails(40).hash | |||
There was a problem hiding this comment.
are we doing this everywhere as a matter of consistency? It seems like we only currently need this in the :besu artifact, but I don't see a reason not to be consistent across all
There was a problem hiding this comment.
Yes, I updated all of the gradle sub-modules where we're setting Implementation-Version to also set a Commit-Hash for consistency. Currently, it's only used in the besu module
garyschulte
reviewed
Aug 30, 2024
| @@ -823,7 +823,7 @@ task distDocker { | |||
| dockerPlatform = "--platform ${project.getProperty('docker-platform')}" | |||
| println "Building for platform ${project.getProperty('docker-platform')}" | |||
| } | |||
| def gitDetails = getGitCommitDetails(7) | |||
| def gitDetails = getGitCommitDetails() | |||
There was a problem hiding this comment.
8 seems fine, but if we are going to generate commit sha metadata that is different from the build artifact name, we may as well use all 40 here
garyschulte
approved these changes
Aug 30, 2024
Signed-off-by: garyschulte <garyschulte@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
re-fixes #6471
for reference:
https://github.com/ethereum/execution-apis/blob/main/src/engine/identification.md
The story behind this PR is as follows: The initial implementation of engine_getClientVersionV1 relied on including the commit hash in the Implementation-Version, to then be parsed in the BesuInfo class. As such, gradle was updated to use 8 character commit hashes, and ensure the memoized output of calculateVersion always included a commit hash. This caused a mismatch in the docker develop github action, which supplied a version with a 7 character commit hash. At this point, we reverted the changes made to implement engine_getClientVersionV1 and began work on the content of this PR to reintroduce engine_getClientVersionV1 with a less disruptive method of obtaining the commit hash. As seen in this PR, the method used is to include a Commit-Hash attribute in the MANIFEST.mf file of all built submodule jars. BesuInfo then extracts the commit hash, and the version is left as it was in both gradle and java runtimes.