Manifest Generation Improvements #179
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
This breaks out the Plugin-Class population into its own task that generates a dedicated manifest file. Rather than having a subclass of Manifest be responsible for scanning the classesDirs and populating a field, we'll move toward generating separate manifests and combining them just before the jar and jpi are created. This is part of the work to better model inputs of the manifest and support the new configuration cache. JENKINS-58205
After some thought it seems simplest to break the most complicated parts of manifest generation into their own tasks and later combine them. Renaming since this approach is more about the manifest than the legacy entry of Plugin-Class. JENKINS-58205
This breaks out the need for sezpoz annotation scanning into its own task. The manifest is also required in generation of the test hpl and the Jenkins server hpl. Task dependencies are set up using Gradle's automatic linkage between task outputs and task inputs. JENKINS-58205
Populate Libraries within GenerateHplTask from a ConfigurableFileCollection Classpath Input. Deprecate the currently unused JpiExtension#mainSourceTree() and JpiExtension#testSourceTree(). The sourcesets are already available on the project. JENKINS-58205
Aggregates the other partial manifest generation tasks and adds Group-Id JENKINS-58205
This respects the current behavior of appending a timestamp to versions that end in -SNAPSHOT, but it means that the task is frequently out-of-date. Prior to 1.0.0, it should be determined whether this plugin providing partial version calculation is beneficial, given that it means all downstream tasks are always invalidated and many other plugins exist for gradle versioning. JENKINS-58205
JpiManifest is now deprecated and unused anywhere within the codebase. The configureManifest task no longer depends on the JpiManifest class. Backwards compatibility is retained by manually defined setId, id, setEmail, email, setName, name methods. While the pom pulls from more fields, these three are the only fields used in the manifest. JENKINS-58205
* Tests for up-to-date checks of tasks. * Plugin-Dependencies relies on plugins added to a number of dynamic configurations, but still uses the #analyse() function to determine the plugin dependencies. It's too difficult to do this from just a fileset. * Update the merge logic to not end up with duplicate Manifest-Version properties. * Deprecate configureManifest task JENKINS-58205
This support was added in Gradle 6.7 JENKINS-58205
Closed
|
I published this as In v0.41.0 and earlier this will not cause the main source set to compile: After these changes, compilation happens if necessary. |
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.
This change aims to be backwards-compatible while fixing up-to-date tracking for manifest generation, improving task configuration avoidance, and leveraging lazy configuration. It lays the groundwork for eventually supporting configuration cache and moves the implementation toward Kotlin. Finally, it deprecates several classes, methods, and fields that will be removed in v1.0.0.
It's a goal of this work to change the implementation without meaningfully changing the output. Any fields that may be different from a maven-hpi-plugin run should be addressed in a different change.
Task Configuration Avoidance/Incremental Build
Jenkins manifest generation is complex. This plugin generates two useful manifests -- jpi and hpl.
Jpi Manifest
The jpi manifest has over a dozen entries that are either quite expensive, or very cheap to produce. To better reflect this, several new tasks have been introduced.
generateJenkinsPluginClassManifestThis task produces an intermediate manifest with only the
Plugin-Classentry. It needs to look through all outputs of the main source set for a sole subclass ofhudson.Plugin. Any change to the main source set requires this task to be re-run.The Jenkins project now prefers using
@Extensionannotations instead, but this remains for backwards-compatibility.generateJenkinsPluginDependenciesManifestThis task produces an intermediate manifest with only the
Plugin-Dependenciesentry. This value is calculated from the existingDependencyAnalysisclasses, but a temporary Java bridge has been introduced to make this value accessible from the Kotlin code.To support up-to-date tracking, this task considers artifacts that meet all the following criteria as inputs:
LibraryElements=jpiconfigurationsserverRuntime(else cyclical task dependency)testRuntime(else cyclical task dependency)It's necessary to not hardcode the supported configurations, because any registered feature variant is included as an optional plugin dependency.
Unfortunately the files alone are not enough to construct the
Plugin-Dependenciesformat, so the actual task execution still calls back to the project. This currently prevents configuration caching from working. A@PendingFeaturespec is in the codebase that tests this condition.generateJenkinsSupportDynamicLoadingManifestThis task produces an intermediate manifest with only the
Support-Dynamic-Loadingentry. The value is determined by building a sezpoz index of the main source set and aggregating the@Extension#dynamicLoadablevalues of everything found. Any change to the main source set requires this task to be re-run.generateJenkinsManifestThis task produces the final jpi manifest that is consumed by the
jarandjpi. It models everything else, including the three intermediate manifests from above, as inputs so it is re-run when required.One oddity to be aware of is if your project version ends in
-SNAPSHOT, the plugin appends a timestamp. This causes this task, and downstream tasks, to be out-of-date all the time. I'd recommend using something likenebula.release'sdevSnapshottask instead of the built-in behavior. I'm considering removing the timestamp behavior, or making it opt-in, by v1.0.0.Hpl Manifest
This manifest builds on the jpi manifest, adding the
LibrariesandResource-Pathentries.Previously this was modeled as a subclass that took a constructor argument of
Project.Now the generated jpi manifest is considered an input to the
GenerateHplTask, which will cause the hpl to be regenerated whenever the upstream manifest changes. Additionally, by not using theProjectclass at execution time, we move closer towards supporting the configuration cache.Lazy Configuration
This change favors using lazy properties in
JpiExtensionwhile also retaining backwards compatibility. Several tests have been added for populating nested closures with assignments and method calls. So far it hasn't seemed necessary to deprecate many of these extension methods.Deprecations
org.jenkinsci.gradle.plugins.jpi.JpiExtension#developersorg.jenkinsci.gradle.plugins.jpi.JpiExtension.Developersorg.jenkinsci.gradle.plugins.jpi.JpiExtension#mainSourceTreeorg.jenkinsci.gradle.plugins.jpi.JpiExtension#testSourceTreeorg.jenkinsci.gradle.plugins.jpi.JpiManifestorg.jenkinsci.gradle.plugins.jpi.JpiHplManifestconfigureManifesttaskFixes JENKINS-58205.
Closes #178.