Module: Buildr::Packaging::Java
Overview
Adds packaging for Java projects: JAR, WAR, AAR, EAR, Javadoc.
Defined Under Namespace
Modules: WithManifest Classes: AarTask, EarTask, JarTask, Manifest, WarTask
Instance Attribute Summary collapse
-
#manifest ⇒ Object
Manifest used for packaging.
-
#meta_inf ⇒ Object
Files to always include in the package META-INF directory.
Instance Method Summary collapse
-
#package_with_javadoc(options = nil) ⇒ Object
:call-seq: package_with_javadoc(options?).
-
#package_with_sources(options = nil) ⇒ Object
:call-seq: package_with_sources(options?).
Methods included from Extension
Instance Attribute Details
#manifest ⇒ Object
Manifest used for packaging. Inherited from parent project. The default value is a hash that includes the Build-By, Build-Jdk, Implementation-Title and Implementation-Version values. The later are taken from the project’s comment (or name) and version number.
598 599 600 |
# File 'lib/buildr/java/packaging.rb', line 598 def manifest @manifest end |
#meta_inf ⇒ Object
Files to always include in the package META-INF directory. The default value include the LICENSE file if one exists in the project’s base directory.
602 603 604 |
# File 'lib/buildr/java/packaging.rb', line 602 def @meta_inf end |
Instance Method Details
#package_with_javadoc(options = nil) ⇒ Object
:call-seq:
package_with_javadoc()
Call this when you want the project (and all its sub-projects) to create a JavaDoc distribution. You can use the JavaDoc distribution in an IDE when coding against the API.
A JavaDoc distribution is a ZIP package with the classifier ‘javadoc’, which includes all the sources used by the compile task.
Packages use the project’s manifest and meta_inf properties, which you can override by passing different values (e.g. false to exclude the manifest) in the options.
To create JavaDoc distributions only for specific projects, use the :only and :except options, for example:
package_with_javadoc :only=>['foo:bar', 'foo:baz']
(Same as calling package :javadoc on each project/sub-project that has source directories.)
649 650 651 652 653 654 655 656 657 658 |
# File 'lib/buildr/java/packaging.rb', line 649 def package_with_javadoc( = nil) ||= {} enhance do selected = [:only] ? projects([:only]) : [:except] ? ([self] + projects - projects([:except])) : [self] + projects selected.reject { |project| project.compile.sources.empty? }. each { |project| project.package(:javadoc) } end end |
#package_with_sources(options = nil) ⇒ Object
:call-seq:
package_with_sources()
Call this when you want the project (and all its sub-projects) to create a source distribution. You can use the source distribution in an IDE when debugging.
A source distribution is a ZIP package with the classifier ‘sources’, which includes all the sources used by the compile task.
Packages use the project’s manifest and meta_inf properties, which you can override by passing different values (e.g. false to exclude the manifest) in the options.
To create source distributions only for specific projects, use the :only and :except options, for example:
package_with_sources :only=>['foo:bar', 'foo:baz']
(Same as calling package :sources on each project/sub-project that has source directories.)
621 622 623 624 625 626 627 628 629 630 |
# File 'lib/buildr/java/packaging.rb', line 621 def package_with_sources( = nil) ||= {} enhance do selected = [:only] ? projects([:only]) : [:except] ? ([self] + projects - projects([:except])) : [self] + projects selected.reject { |project| project.compile.sources.empty? }. each { |project| project.package(:sources) } end end |