Author: assaf
Date: Fri Apr 11 12:39:07 2008
New Revision: 647279
URL: http://svn.apache.org/viewvc?rev=647279&view=rev
Log:
Added reference to settings.yaml/build.yaml description in what's new page.
Modified:
incubator/buildr/trunk/doc/pages/more_stuff.textile
incubator/buildr/trunk/doc/pages/settings_profiles.textile
incubator/buildr/trunk/doc/pages/whats_new.textile
Modified: incubator/buildr/trunk/doc/pages/more_stuff.textile
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/more_stuff.textile?rev=647279&r1=647278&r2=647279&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/more_stuff.textile (original)
+++ incubator/buildr/trunk/doc/pages/more_stuff.textile Fri Apr 11 12:39:07 2008
@@ -47,6 +47,7 @@
with a partial classpath, or before all remote repositories are listed.
# Check on a clean build with empty local repository.
+
h2. Nailgun
"Nailgun":http://www.martiansoftware.com/nailgun/index.html is a client,
Modified: incubator/buildr/trunk/doc/pages/settings_profiles.textile
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/settings_profiles.textile?rev=647279&r1=647278&r2=647279&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/settings_profiles.textile (original)
+++ incubator/buildr/trunk/doc/pages/settings_profiles.textile Fri Apr 11
12:39:07 2008
@@ -92,7 +92,7 @@
file under your home directory. Settings stored there will be applied the same
across all builds.
-Here's an example settings.yaml:
+Here's an example @settings.yaml@:
{{{!yaml
# The repositories hash is read automatically by buildr.
@@ -130,16 +130,17 @@
end
}}}
+
h2. Build Settings
-Build settings are local to the project being built, and are placed in the
[EMAIL PROTECTED]@ file located in the same directory that the @[EMAIL
PROTECTED] Normally
+Build settings are local to the project being built, and are placed in the
[EMAIL PROTECTED]@ file located in the same directory that the @[EMAIL
PROTECTED] Normally
this file would be managed by the project revision control system, so settings
here are shared between developers.
They help keep the buildfile and build.yaml file simple and readable, working
-to the advantages of each one.
-Example for build settings are gems, repositories and artifacts used by that
build.
+to the advantages of each one. Example for build settings are gems,
+repositories and artifacts used by that build.
{{{!yaml
# This project requires the following ruby gems, buildr addons
Modified: incubator/buildr/trunk/doc/pages/whats_new.textile
URL:
http://svn.apache.org/viewvc/incubator/buildr/trunk/doc/pages/whats_new.textile?rev=647279&r1=647278&r2=647279&view=diff
==============================================================================
--- incubator/buildr/trunk/doc/pages/whats_new.textile (original)
+++ incubator/buildr/trunk/doc/pages/whats_new.textile Fri Apr 11 12:39:07 2008
@@ -3,7 +3,7 @@
h2. Buildr 1.3
-h4. Multiple Languages
+h3. Multiple Languages
The main focus of this release is supporting multiple languages for compiling
and testing.
@@ -42,21 +42,21 @@
add new compilers; however, I had to change the test framework API to
accommodate the new features, so old test frameworks will not work on 1.3.
-h4. Scala Support
+h3. Scala Support
Buildr now supports Scala, using both native and fast Scala compiler.
Read more about "using Scala":building.html#compiling_scala.
-h4. Groovy Support
+h3. Groovy Support
Buildr now supports Groovy, using the Groovyc Ant task.
Read more about "using Groovy":building.html#compiling_groovy.
-h4. Packaging Files
+h3. Packaging Files
The @package@ method is convenient enough that you can now use it to generate
artifacts, an in addition to generate regular file tasks, specifying the file
@@ -74,7 +74,7 @@
method":packaging.html#specifying_and_referencing_packages.
-h4. Packaging EARs
+h3. Packaging EARs
EAR packages support four component types:
@@ -107,7 +107,7 @@
"Read more ...":packaging.html#packaging_ears
-h4. JRuby Support
+h3. JRuby Support
We now offer two versions of Buildr, one for Ruby and one for JRuby. They're
exactly the same, except the Ruby version will also install RJB (Ruby Java
@@ -121,7 +121,8 @@
"Read more ...":more_stuff.html#nailgun
-h4. Behaviour-Driven Development
+
+h3. Behaviour-Driven Development
Given that many languages are now supported by Buildr, the same is true for
testing, the convention is to store BDD files under the @src/spec/{lang}@
@@ -136,7 +137,8 @@
"Read more ...":testing.html#bdd
-h4. Profiles
+
+h3. Profiles
Different environments may require different configurations, some you will want
to control with code, others you will want to specify in the profiles file.
@@ -164,12 +166,77 @@
jdbc: oracle:thin:@bigstrong:1521:mighty
}}}
-You can also use profiles to specify default filters for the "@resources@
task":building.html#resources.
+You can also use profiles to specify default filters for the "@resources@
+task":building.html#resources.
"Read more ...":settings_profiles.html#profiles
-h4. New API for accessing Java libraries
+h3. Settings and build YAML files
+
+In addition to profiles, we also allow you to specify personal and build
+settings using two YAML files.
+
+Personal settings are placed in the @.buildr/settings.yaml@ file under your
+home directory. Settings stored there will be applied the same across all
+builds.
+
+For example:
+
+{{{!yaml
+# The repositories hash is read automatically by buildr.
+repositories:
+
+ # customize user local maven2 repository location
+ local: some/path/to/my_repo
+
+ relase_to:
+ url: http://intra.net/maven2
+ username: john
+ password: secret
+
+# You can place settings of your own, and reference them
+# on buildfiles.
+im:
+ server: jabber.company.com
+ usr: [EMAIL PROTECTED]
+ pwd: secret
+}}}
+
+"Read more ...":settings_profiles.html#personal_settings
+
+Build settings are placed in the @build.yaml@ file located in the same
+directory that the @[EMAIL PROTECTED] Normally this file would be managed by
the
+project revision control system, so settings here are shared between
+developers.
+
+For example:
+
+{{{!yaml
+# This project requires the following ruby gems, buildr addons
+gems:
+ # Suppose we want to notify developers when testcases fail.
+ - buildr-twitter-notifier-addon >=1
+ # we test with ruby mock objects
+ - mocha
+ - ci_reporter
+
+# The artifact declarations will be automatically loaded by buildr, so that
+# you can reference artifacts by name (a ruby-symbol) on your buildfile.
+artifacts:
+ spring: org.springframework:spring:jar:2.0
+ log4j: log4j:log4j:jar:1.0
+ j2ee: geronimo-spec:geronimo-spec:j2ee:jar:1.4-rc4
+
+# Of course project settings can be defined here
+jira:
+ uri: https://jira.corp.org
+}}}
+
+"Read more ...":settings_profiles.html#build_settings
+
+
+h3. New API for accessing Java libraries
Java classes are accessed as static methods on the @Java@ module, for example:
@@ -201,7 +268,7 @@
"Read more ...":more_stuff.html#using_java_libraries
-h4. Creating Extensions
+h3. Creating Extensions
A module defines instance methods that are then mixed into the project and
become instance methods of the project. There are two general ways for
@@ -230,7 +297,7 @@
"Read more ...":extending.html#creating_extensions
-h4. Using Alternative Layouts
+h3. Using Alternative Layouts
Buildr follows a common convention for project layouts: Java source files
appear in @src/main/java@ and compile to @target/classes@, resources are
@@ -245,7 +312,7 @@
"Read more ...":extending.html#using_alternative_layouts
-h4. Other
+h3. Other
* Buildr 1.3 upgrades to Rake 0.8, RSpec 1.1, RJB 1.1 and OpenJPA
1.0.1. Buildr no longer includes or uses Facets.
@@ -260,7 +327,7 @@
to the compile task.
-h4. Documentation
+h3. Documentation
* The "What's new?":whats_new.html page (this one, actually), summarizes all
the important new features and changes in each release.
