Add additional plugin manifest entries #436
Merged
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
Adds the following Manifest entries Artifact-Id : whilst there was Short-Name that used artifactId it could be changed and it is best to have somrthing that wont ever change. Could have been obtained from the pom.xml or pom.properties - but that requires you to go looking Plugin-Scm-Connection : currently the PCT is forcing plugins to specify this in mulit module projects which is convoluted. Also moving here can simplify in the future by removing the need to parse any poms. Plugin-Scm-Git-Hash : put the Git SHA used for the HEAD of the plugin build. Allows the recording of a commit for a SNAPSHOT build. Plugin-Scm-Git-Module-Path : the path of the project relative to the git project.
jtnord
force-pushed
the
more-metadata
branch
from
b8b40ce to
6c18cef
Compare
jtnord
commented
Feb 17, 2023
| public String getGitHeadSha1() { | ||
| // we want to allow the plugin that's not sitting at the root (such as findbugs plugin), | ||
| // but we don't want to go up too far and pick up unrelated repository. | ||
| File git = new File(project.getBasedir(), ".git"); |
There was a problem hiding this comment.
this was questionable to begin with.
it implies that
- you can only ever have a 1 level structure
- it would be valid and useful to checkout a non git project into a clone of a git projects directory structure (but only at 2 levels or lower!)
| } | ||
|
|
||
| protected String getGitRevParseOutput(String revparseArg) { | ||
| if (!project.getScm().getConnection().startsWith("scm:git")) { |
There was a problem hiding this comment.
rather than looking for a .git folder in the hierachy we now just ask the project if its connection starts with scm:git
This does not need to be set for every plugin in a reactor, as the model we have contains inherited data.
| try { | ||
| Process p = new ProcessBuilder("git", "-C", git.getAbsolutePath(), "rev-parse", "HEAD").redirectErrorStream(true).start(); | ||
| Process p = new ProcessBuilder("git", "rev-parse", revparseArg).directory(project.getBasedir()).redirectErrorStream(true).start(); |
There was a problem hiding this comment.
switch from -C thePath to running git in the actual path.
| @@ -124,6 +124,8 @@ protected void setAttributes(Manifest.ExistingSection mainSection) throws MojoEx | |||
| } | |||
|
|
|||
| mainSection.addAttributeAndCheck(new Manifest.Attribute("Group-Id",project.getGroupId())); | |||
| mainSection.addAttributeAndCheck(new Manifest.Attribute("Artifact-Id",project.getArtifactId())); | |||
There was a problem hiding this comment.
There is no harm in adding this value explicitly.
| addAttributeIfNotNull(mainSection, "Plugin-ScmUrl", getScmUrl()); | ||
| addAttributeIfNotNull(mainSection, "Plugin-Scm-Connection", getSCMConnection()); |
There was a problem hiding this comment.
so that it could be obtained in the future without projects having to pollute their own pom.
| addAttributeIfNotNull(mainSection, "Plugin-ScmUrl", getScmUrl()); | ||
| addAttributeIfNotNull(mainSection, "Plugin-Scm-Connection", getSCMConnection()); | ||
| addAttributeIfNotNull(mainSection, "Plugin-Scm-Git-Hash", getGitHeadSha1(false)); |
There was a problem hiding this comment.
useful for tracking SNAPSHOT deployments.
Possibly helpful for testing SNAPSHOT builds in the PCT.
| addAttributeIfNotNull(mainSection, "Plugin-ScmUrl", getScmUrl()); | ||
| addAttributeIfNotNull(mainSection, "Plugin-Scm-Connection", getSCMConnection()); | ||
| addAttributeIfNotNull(mainSection, "Plugin-Scm-Git-Hash", getGitHeadSha1(false)); | ||
| addAttributeIfNotNull(mainSection, "Plugin-Scm-Git-Module-Path", getGitModulePath()); |
| // normalize to Unix style | ||
| return path.replace(File.separatorChar, '/'); | ||
| } catch (IOException e) { | ||
| getLog().warn("failed to obtain projects relative location in the Git repository", e); |
There was a problem hiding this comment.
goes against the fine level if git rev-parse HEAD fails in the existing code - but really this should not happen - we are a git project.
basil
requested changes
Feb 21, 2023
daniel-beck
changed the title
jtnord
added a commit
to jtnord/aws-java-sdk-plugin
that referenced
this pull request
Mar 24, 2023
testing jenkinsci/maven-hpi-plugin#436 to add additional manifest entries
Closed
6 tasks
6 tasks
basil
approved these changes
Apr 12, 2023
basil
added a commit
to jtnord/plugin-compat-tester
that referenced
this pull request
Apr 12, 2023
6 tasks
jtnord
added a commit
to jenkinsci/plugin-compat-tester
that referenced
this pull request
Apr 17, 2023
This changes the way the PCT clones from per plugin to per repository. Once the repository is cloned it then exercises each plugin in the repo in turn (serially). plugins that are excluded (or implicitly if an include list is provided) will not be tested even if some other plugin in the same repository is tested. It is assumed that all plugins in the same repository will use the same tag (however this is not explicitly prevented - but can be if deemed necessary) The pct command is no longer a root command but is now a sub command test-plugins and any caller of the PCT will need to be adjusted to use this sub command. There is a new command list-plugins that will list all plugins in the war (excluding detached) that can also filter by includes or excludes. Tooling can call this in order to group plugin tests for the same repository. (as above this does not group by repository and tag - it is assumed that the version of plugins from the same repository will be the same - this can be added if required, or we can group by repository and commit) All AbstractMultiParentHook have been removed and similar to the git url workaround has been inlined into code that should become dead once all plugins have been updated to include jenkinsci/maven-hpi-plugin#436 The support is currently via a hook like MetadataExtractor - all implkementations of this are expected to be removed when plugins are migrated, simplifying the implementation. --------- Co-authored-by: Basil Crow <me@basilcrow.com>
Merged
6 tasks
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.
Adds the following Manifest entries
Artifact-Idwhilst there was Short-Name that used artifactId it could be changed (however unlikely) and it is best to have something that won't ever change.
Could have been obtained from the pom.xml or pom.properties - but that requires you to go looking
Plugin-ScmConnectioncurrently the PCT is forcing plugins to specify this in mulit module projects which is convoluted.
Also moving here could simplify in the future by removing the need to parse any poms.
Plugin-ScmTaga tag as specified by
${project.scm.tag}which may beHEADif the project is is neither a release nor an incremental version.Plugin-GitHashput the Git SHA used for the HEAD of the plugin build.
Allows the (best effort) recording of a commit used for a SNAPSHOT build. (no longer needs to be extracted from the private build information)
Plugin-Modulethe path of the project relative to the git project.
Regardless of any future PCT work to use these additions
Plugin-Scm-Git-Hashis useful when looking at a deployed SNAPSHOT today and the others do no harm.