diff --git a/componentbuild/README b/componentbuild/README index bad1e15..c6e769c 100644 --- a/componentbuild/README +++ b/componentbuild/README @@ -211,10 +211,11 @@ If you're creating: FURTHER CUSTOMIZATION If required, you can define custom values for any of the properties -defined in README.properties to customize the build for your new component, -however as mentioned above, for most components, the properties defined in -the template files, should be sufficient. +defined in builder/componentbuild/docs/properties.html to customize the +build for your new component, however as mentioned above, for most +components, the properties defined in the template files, should be +sufficient. You can also over-ride or extend existing targets, to customize the actual build process for a component if required. The list of targets and their -role is defined in README.targets \ No newline at end of file +role is defined in builder/componentbuild/docs/targets.html. diff --git a/componentbuild/docs/targets.html b/componentbuild/docs/targets.html new file mode 100644 index 0000000..7579c38 --- /dev/null +++ b/componentbuild/docs/targets.html @@ -0,0 +1,208 @@ + + + + + + + + YUI ANT Target Definitions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

CORE TARGET DEFINITIONS

(componentbuild/shared/targets.xml)

+
TargetDescription
allInvokes local and then deploy. This is + what you would normally call when you're ready + to check in your code to the build + directory.
localInvokes clean, init, build, minify and + lint. This is what you would normally call, + when going through a development build, test, build, test cycle.
cleanDeletes the local build dir.
initCreates the component's local build dir + (e.g. yui2/src/autocomplete/build_tmp).
buildBuilds the component files in the local build dir. + The work actually performed in the build step varies + for the type of component and is defined by the type of + build file pulled in: +
    +
  • componentbuild/2.x/module.xml (2.x module targets)
    • +
  • componentbuild/3.x/module.xml (3.x standalone module targets)
    • +
  • componentbuild/3.x/rollup.xml (3.x rollup module targets)
    • +
  • componentbuild/shared/cssmodule.xml (2.x, 3.x CSS module targets)
    • +
+ The build targets introduced for + the above component types are discussed in + detail below.
minifyCompresses the built files in the local + build directory, to create + <component>-min.js (or + <component>-min.css for CSS modules)
lintRuns jslint on the built files in the local build directory.
deployCopies the built files from the local build + directory, along with any assets, to the top + level build directory. It invokes deploybuild, + deployassets, deployskins and deploydocs.
deploybuildCopies built files to global build location.
deployskinsCopies built skin CSS and related assets to the global build directory.
deployassetsCopies non-skin related assets to the global build directory, if they exist.
deploydocsThis target is currently a no-op.
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+

YUI 2, YUI 3 MODULE BUILD

+

(componentbuild/2.x/module.xml, componentbuild/3.x/module.xml)

+
TargetDescription
buildInvokes the buildcore and buildskins targets
buildcoreInvokes builddebug. The results of + builddebug are then stripped of log statements to create the core (<component>.js) file.
builddebugConcatenates the raw source files (with log + statements), to create <component>-debug.js, and adds the boilerplate registration code.
buildskinsBuilds the component's Sam Skin file, by + concatenating and <component>-core.css + and <component>-skin.css. It also + compresses the file using yuicompressor.
+ + + + + + + + + + + + + + + + + + +
+

YUI 3 ROLLUP BUILD

(componentbuild/3.x/rollup.xml)

+
TargetDescription
buildInvokes buildmodules
buildmodulesInvokes the specified build xml file for each + of the sub modules, which build out the + modules, as normal, but also roll the results + back up into the rollup. The resulting rollup + files, then have the boilerplate registration + code added.
+ + + + + + + + + + + + + + + + + + +
+

CSS MODULE BUILD

(componentbuild/shared/cssmodule.xml)

+
TargetDescription
buildInvokes the buildcore target. Note that for + CSS modules, we don't need a buildskins, or + builddebug step.
buildcoreConcatenates the raw CSS files.
+ + + diff --git a/componentbuild/shared/targets.xml b/componentbuild/shared/targets.xml index c64faf0..f683654 100644 --- a/componentbuild/shared/targets.xml +++ b/componentbuild/shared/targets.xml @@ -2,38 +2,6 @@ - - Starting Build For ${component} Ant Properties