Mailing-List: contact issues-help@maven.apache.org; run by ezmlm
Precedence: bulk
Reply-To: dev@maven.apache.org
Date: Wed, 13 Jan 2016 05:37:40 +0000 (UTC)
From: "Manfred Moser (JIRA)" <jira@apache.org>
To: issues@maven.apache.org
Message-ID: <JIRA.12805659.1356033025000.94402.1452663460746@Atlassian.JIRA>
In-Reply-To: <JIRA.12805659.1356033025000@Atlassian.JIRA>
References: <JIRA.12805659.1356033025000@Atlassian.JIRA>
 <JIRA.12805659.1356033025917@arcas>
Subject: [jira] [Closed] (MNGSITE-167) Maven Getting Started Guide should
 clarify SNAPSHOT qualifier of 'version' element precedes release
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: quoted-printable


     [ https://issues.apache.org/jira/browse/MNGSITE-167?page=3Dcom.atlassi=
an.jira.plugin.system.issuetabpanels:all-tabpanel ]

Manfred Moser closed MNGSITE-167.
---------------------------------
    Resolution: Fixed

> Maven Getting Started Guide should clarify SNAPSHOT qualifier of 'version=
' element precedes release
> -------------------------------------------------------------------------=
--------------------------
>
>                 Key: MNGSITE-167
>                 URL: https://issues.apache.org/jira/browse/MNGSITE-167
>             Project: Maven Project Web Site
>          Issue Type: Bug
>            Reporter: Dan Rollo
>            Assignee: Manfred Moser
>         Attachments: MNGSITE_167_add_missing_description_of_SNAPSHOT.patc=
h
>
>
> In the "Maven Getting Started Guide"=20
> http://maven.apache.org/guides/getting-started/index.html
> (linked to as: "Getting Started Tutorial" from: http://maven.apache.org/u=
sers/index.html,=20
> which is linked to as: "Use Maven" from: http://maven.apache.org/
> )
> under the link: "How do I make my first Maven project?", the description =
bullet for the "version" pom element mentions SNAPSHOT as follows:
> 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 th=
at a project is in a state of development. We will discuss the use of snaps=
hots and how they work further on in this guide.
> Though a later description is promised, the concept that a SNAPSHOT versi=
on "preceeds" the non-SNAPSHOT (aka "release") version is never mentioned i=
n this document.
> I have had to describe this fact to a number of people as well, so I thin=
k this 'version' element doc should be changed to mention a SNAPSHOT preced=
es a release (or some new section added elsewhere in this doc to clarify th=
is point).
> Here are some of the other responses from the user list that might help t=
o come up with a clear doco snippet:
> 1.=20
> A SNAPSHOT is the development version before producing the release.
> A SNAPSHOT is older than its release
> 1.0.0-SNAPSHOT -> 1.0.0-> 1.0.1-SNAPSHOT -> 1.0.1 -> ..
> 2.=20
> 1.0.0 is newer than 1.0.0-SNAPSHOT
> 3.=20
> x.x.x-SNAPSHOT is the precursor to x.x.x  The SNAPSHOT value is used to a=
llow
> the version to refer to the 'latest' code along a branch and provides no
> guarantee that the code is stable or unchanging.  The release process cha=
nges
> x.x.x-SNAPSHOT to x.x.x, freezes the code to provide a guarantee that the
> version is unchanging.  The release process should also move the version =
to
> x.x.x+1-SNAPSHOT.=20
> =20
> It follows that any released code cannot be dependent on SNAPSHOT code
> Below is a thread snippet from maven users mailing list:
> Subject:
> Re: 1.0.0-SNAPSHOT considered older than 1.0.0?
> From:
> <org.apache.maven.user@io7m.com>
> Date:
> 12/20/2012 10:09 AM
> To:
> "Maven Users List" <users@maven.apache.org>
> On Thu, 20 Dec 2012 15:08:26 +0100
> Arnaud H=C3=83=C2=A9ritier <aheritier@gmail.com> wrote:
> > I don't have the time to check the doc but if it's not in, this is a bi=
g
> > error (don't hesitate to open an issue)
> > A SNAPSHOT is the development version before producing the release.
> > A SNAPSHOT is older than its release
> > 1.0.0-SNAPSHOT -> 1.0.0-> 1.0.1-SNAPSHOT -> 1.0.1 -> ..
> Thanks to all that replied.
> The missing documentation I was referring to was:
>   http://maven.apache.org/guides/getting-started/index.html#How_do_I_make=
_my_first_Maven_project
> Note:
>   "We will discuss the use of snapshots and how they work further on in
>   this guide"
> The word "snapshots" doesn't appear again on the page.


--
This message was sent by Atlassian JIRA
(v6.3.4#6332)