Repository navigation
Javadoc footer: resolve the abbreviated commit id - #797
Merged
Merged
Conversation
The footer showed a literal ${git.commit.id.abbrev}, and "Foundation.All"
had no space.
- The git-commit-id plugin's includeOnlyProperties dropped
git.commit.id.abbrev, so the property was never defined.
- The plugin produced git.commit.id but not git.commit.id.full, which the
manifests use. Release builds worked only because
mvn_clean_install_or_deploy.sh passes -Dgit.commit.id.full.
This sets commitIdGenerationMode to full and keeps git.commit.id.full and
git.commit.id.abbrev. It puts the footer on one line, and the release
script also passes -Dgit.commit.id.abbrev (7 characters, or unknown without
a .git directory).
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or 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
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.
A minor documentation fix for the next release. 9.1.0 and gh-pages are left as they are.
The 9.1.0 Javadoc footer reads:
Cause
includeOnlyPropertiesfilter droppedgit.commit.id.abbrev, so Maven left the placeholder as text.git.commit.idrather thangit.commit.id.full, which the jar manifests use. Release jars were correct only becausetools/mvn_clean_install_or_deploy.shpasses-Dgit.commit.id.full. A plainmvn package, or thejavadoc.ymlworkflow, left it unresolved.<bottom>text was split across two lines, and javadoc joined them without a space.Changes
pom.xml:commitIdGenerationModeis set tofull.includeOnlyPropertieskeepsgit.commit.id.fullandgit.commit.id.abbrevinstead ofgit.commit.id.tools/mvn_clean_install_or_deploy.shalso passes-Dgit.commit.id.abbrev: 7 characters, orunknownwithout a.gitdirectory.Checked
mvn clean javadoc:javadocgives… The Apache Software Foundation. All rights reserved. (Commit Time: …, Commit: ef440a8).mvn packagejar manifest has the realgit-commit-id.mvn apache-rat:checkpasses.🤖 Generated with Claude Code