Add default manifest entries with Maven #318
Conversation
| Manifest manifest = new Manifest(is) | ||
| assert !manifest.getMainAttributes().getValue('Build-Jdk-Spec').isEmpty() | ||
| assert manifest.getMainAttributes().getValue('Created-By').startsWith('Maven Archiver') | ||
| assert manifest.getMainAttributes().getValue('Extension-Name') == null // was provided by Maven 2, but core prefers Short-Name |
There was a problem hiding this comment.
Maven 2 set this to the short name, but Maven 3 does not. Core always checks Short-Name first and only falls back to Extension-Name if Short-Name is not present. And we always set Short-Name in this plugin. So this was always redundant and can be safely removed.
| assert manifest.getMainAttributes().getValue('Extension-Name') == null // was provided by Maven 2, but core prefers Short-Name | ||
| assert manifest.getMainAttributes().getValue('Group-Id').equals('org.jenkins-ci.tools.hpi.its') | ||
| assert manifest.getMainAttributes().getValue('Hudson-Version').equals('2.249.1') | ||
| assert manifest.getMainAttributes().getValue('Implementation-Title').equals('MyNewPlugin') // was project.artifactId in previous versions, now project.name |
There was a problem hiding this comment.
Maven 2 set this to the artifact ID, but Maven 3 sets this to the project name. I couldn't find any code in the ecosystem that relied on this being set to any particular value.
| assert manifest.getMainAttributes().getValue('Plugin-ScmUrl').equals('https://github.com/jenkinsci/maven-hpi-plugin') | ||
| assert manifest.getMainAttributes().getValue('Plugin-Version').startsWith('1.0-SNAPSHOT') | ||
| assert manifest.getMainAttributes().getValue('Short-Name').equals('verify-it') | ||
| assert manifest.getMainAttributes().getValue('Specification-Title').equals('MyNewPlugin') // was project.description in previous versions, now project.name |
There was a problem hiding this comment.
Core does consume this to display on the installed plugins page, but only if src/main/resources/index.jelly is not present. As of #302 we enforce the existence of src/main/resources/index.jelly, so changing the semantics of Specification-Title will not result in any change in behavior.
|
I am not sure this is a |
Co-authored-by: Jesse Glick <[email protected]>
Changed to |
Cleans up a small amount of technical debt introduced in #251 during the transition to Maven 3. Supersedes #284. With this PR, we rely on Maven to add the default specification entries and default implementation entries to the manifest. This allows us to remove some ugly copypasta.
This change is not 100% backward-compatible, but it should be safe for the reasons given in the comments.