svn commit: r1724356 - /maven/site/trunk/content/apt/guides/getting-started/index.apt

[mm...@apache.org]

Author: mmoser
Date: Wed Jan 13 05:35:12 2016
New Revision: 1724356

URL: http://svn.apache.org/viewvc?rev=1724356&view=rev
Log:
[MNGSITE-167] Added snapshot description to getting started guide
Patch supplied by: Dan Rollo
Reviewed and committed by: Manfred Moser

Modified:
    maven/site/trunk/content/apt/guides/getting-started/index.apt

Modified: maven/site/trunk/content/apt/guides/getting-started/index.apt
URL: http://svn.apache.org/viewvc/maven/site/trunk/content/apt/guides/getting-started/index.apt?rev=1724356&r1=1724355&r2=1724356&view=diff
==============================================================================
--- maven/site/trunk/content/apt/guides/getting-started/index.apt (original)
+++ maven/site/trunk/content/apt/guides/getting-started/index.apt Wed Jan 13 05:35:12 2016
@@ -37,6 +37,8 @@ Sections
 
  * {{{./index.html#How_do_I_create_a_JAR_and_install_it_in_my_local_repository}How do I create a JAR and install it in my local repository?}}
 
+ * {{{./index.html#What_is_a_SNAPSHOT_version}What is a SNAPSHOT version?}}
+
  * {{{./index.html#How_do_I_use_plug-ins}How do I use plug-ins?}}
 
  * {{{./index.html#How_do_I_add_resources_to_my_JAR}How do I add resources to my JAR?}}
@@ -177,8 +179,8 @@ mvn -B archetype:generate \
 
   * <<version>> This element indicates the version of the artifact generated by the project. Maven goes a long way
     to help you with version management and you will often see the <<<SNAPSHOT>>> designator in a version, which
-    indicates that a project is in a state of development. We will discuss the use of snapshots and how they work further
-    on in this guide.
+    indicates that a project is in a state of development. We will discuss the use of
+    {{{./index.html#What_is_a_SNAPSHOT_version}snapshots}} and how they work further on in this guide.
 
   * <<name>> This element indicates the display name used for the project. This is often used in Maven's
     generated documentation.
@@ -470,6 +472,33 @@ mvn eclipse:eclipse
   create a JAR from the <<<target/classes>>> directory, under the assumption everything else had already
   been done.
 
+* {What is a SNAPSHOT version?}
+
+  Notice the value of the <<version>> tag in the <<<pom.xml>>> file shown below has the suffix: <<<-SNAPSHOT>>>.
+
++-----+
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  ...
+  <groupId>...</groupId>
+  <artifactId>my-app</artifactId>
+  ...
+  <version>1.0-SNAPSHOT</version>
+  <name>Maven Quick Start Archetype</name>
+  ...
++-----+
+
+  The <<<SNAPSHOT>>> value refers to the 'latest' code along a development branch, and provides no guarantee the
+  code is stable or unchanging. Conversely, the code in a 'release' version (any version value without the suffix <<<SNAPSHOT>>>)
+  is unchanging.
+
+  In other words, a SNAPSHOT version is the 'development' version before the final 'release' version .
+  The SNAPSHOT is "older" than its release.
+
+  During the {{{../../plugins/maven-release-plugin/}release}} process, a version of <<x.x-SNAPSHOT>> changes to
+  <<x.x>>. The release process also increments the development version to <<x.(x+1)-SNAPSHOT>>.
+  For example, version <<1.0-SNAPSHOT>> is released as version <<1.0>>, and the new development version is
+  version <<1.1-SNAPSHOT>>.
+
 * {How do I use plug-ins?}
 
   Whenever you want to customise the build for a Maven project, this is done by adding or reconfiguring plugins.