Crafstman Bundle Capabilities

[top]

This page describes the category of capabilities supported by Craftsman that are Bundle Extensions. You can find more information on bundles and what they provide on the bundle page.

bundle

    EXCLUSIVE[1]

The base capability for any bundle extension. This capability serves as a parent for other bundle-related extensions. Its options and restrictions are inherited by its children.

options:

bundle-name

The name to use for the bundle (and the final bundle file generated). Default value is the bundle ID used in the <bundle> tag declaration plus "-${bundle.version}". If your bundle is named "foo", a "foo.zip" file will be generated. NOTE: by specifying this option, you tell craftsman not to include the version number in the bundle filename.

• valid values:
  • any[2]

library-config-filename

Name to use for the library configuration filename. The default value is "library-${bundleid}.xml" or "library-${bundle-name}.xml" if the bundle-name option was used.. The contents remain the same regardless of the actual filename used.

• valid values:
  • any[2]

include-libraries

Include the libraries this bundle's modules depend on in the final bundle file. Default value is "false". If your module bar, a part of your foo bundle, depends on jakarta-commons, specifying true for this option will create a foo.zip file that includes the jakarta-commons jar files used to build and test the bar module. This option can be used in conjuction with the exclude-library option to tailor make distribution bundles to your needs.

• valid values:
  • "true"
  • "false"

exclude-library

Library to exclude from the bundle (assuming the "include-libraries" option was set to true). This can be any valid library id. If the library id is a part of the library dependencies for the modules in this bundle, it will not be included in the final bundle file.

• multiple entries allowed
• valid values:

include-docs

Include the documentation (API and manual) for the modules in this bundle. If there is no documentation generated, the module is skipped for documentation inclusion (you can force doc generating with the generate-docs option).

• valid values:
  • "true"
  • "false"

generate-docs

Generates the documentation (API and manual) for the modules in this bundle. This option only applies if include-docs is set to true.

• valid values:
  • "true"
  • "false"

[back to top]

craftsman-bundle

    extends bundle
    EXCLUSIVE[1] by inheritance

Capability representing craftsman bundles, that is bundles that make up Craftsman functionality and extensions.

[back to top]

---

[#1] Exclusive in the sense that there can only be one instance of this capability, including any children. So if a parent is marked exclusive, both it and any of its children are considered exclusive of one another, and only one of them may be used in a module.

[#2] The "any" value represents any non-null string, non-empty string. It does not include the null value or the string "".

[#3] The "empty" value represents an empty string, that is "".

[#4] The "none" value represents a null value, which result from an option specification like <option name="foobar"/>.