You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@lucy.apache.org by Marvin Humphrey <ma...@rectangular.com> on 2011/01/09 20:09:15 UTC

[lucy-dev] ReleaseGuide wiki page draft done

Greets,

I believe that the release guide wiki page that Peter started at
<http://wiki.apache.org/lucy/ReleaseGuide> is now feature-complete and ready
for either review or use.

This draft is more of a mechanical, step-by-step recipe than I have seen in
the release guides for some other Apache projects.  Discussions of principle,
such as you find at
<http://incubator.apache.org/guides/releasemanagement.html> have been
streamlined away.

For instance, although the Incubator release documentation treats the LICENSE
and NOTICE files at length, there is no mention of them on our wiki page --
because performing QC on those files is not the RM's direct responsibility.
It is first, the responsibility of individual committers to update them as
necessary with each individual commit; second, the PPMC's responsibility to
oversee development and ensure that they are kept up-to-date on an ongoing
basis; and finally, a PPMC member responsibility to check them before casting
a +1 vote for the release.  The RM has enough to do already.

Additionally, only the steps that must be performed every time are spelled out
in detail; for one-time activities such as PGP key setup, the reader is
referred elsewhere.

The idea is that first-time release managers must familiarize themselves with
the issues involved by consulting expansive Apache documentation, but once
that preparation has been completed and the RM is up-to-speed, our release
guide serves as a succinct enumeration of the actions required to perform a
release -- hopefully just as useful on the third or fourth go-round as on the
first.

The guide currently refers to certain resources that do not yet exist:

    trunk/devel/bin/update_version
    http://www.apache.org/dist/incubator/lucy/KEYS
    http://www.apache.org/dist/incubator/lucy/
    http://archive.apache.org/dist/incubator/lucy/
    download links from the Lucy website

We should work to produce all of these except possibly the archival folder
before starting the release process.

Marvin Humphrey

Re: [lucy-dev] ReleaseGuide wiki page draft done

Posted by Peter Karman <pe...@peknet.com>.
Marvin Humphrey wrote on 01/17/2011 08:00 PM:
> On Fri, Jan 14, 2011 at 06:15:44PM -0800, Chris Hostetter wrote:
>> i think it makes total sense for this to be a distinct wiki page from the 
>> ReleaseGuide (ReleseVerificationChecklist maybe?) becuase the burden 
>> shouldn't be on the release manager to verify everything; and it makes 
>> sense to be brief about the things that generally need checked for all 
>> apache releases (license files, pgp/md5 sigs check out, etc...) but 
>> anything Lucyd specific ("run the unit tests like so...", "build and test 
>> the CPAN artifacts like so...", etc...) would be good list to have on the 
>> wiki.
> 
> +1 for ReleaseVerificationChecklist.
> 
> I think we need three pages, to cover three different areas of responsibility.
> 

+1 to 3 pages.

-- 
Peter Karman  .  http://peknet.com/  .  peter@peknet.com

Re: [lucy-dev] ReleaseGuide wiki page draft done

Posted by Marvin Humphrey <ma...@rectangular.com>.
On Fri, Jan 14, 2011 at 06:15:44PM -0800, Chris Hostetter wrote:
> i think it makes total sense for this to be a distinct wiki page from the 
> ReleaseGuide (ReleseVerificationChecklist maybe?) becuase the burden 
> shouldn't be on the release manager to verify everything; and it makes 
> sense to be brief about the things that generally need checked for all 
> apache releases (license files, pgp/md5 sigs check out, etc...) but 
> anything Lucyd specific ("run the unit tests like so...", "build and test 
> the CPAN artifacts like so...", etc...) would be good list to have on the 
> wiki.

+1 for ReleaseVerificationChecklist.

I think we need three pages, to cover three different areas of responsibility.

    1. ReleasePrep -- Actions to prepare a branch for a release (e.g. update
       the CHANGES file), for which the community is collectively responsible.
    2. ReleaseGuide -- Actions for executing a release, which are the sole
       responsibility of the Release Manager.  (DONE)
    3. ReleaseVerificationChecklist -- A guide for PMC members or other
       interested parties to help judge whether a specific set of release
       artifacts merits a +1 vote of approval.

To create the additional pages, we can distill down the Incubator release page
at <http://incubator.apache.org/guides/releasemanagement.html> as we did for
ReleaseGuide, but apply different filtering criteria.  After that, we can
augment the content with "run the unit tests like so..." as proposed above.

Marvin Humphrey

Re: [lucy-dev] ReleaseGuide wiki page draft done

Posted by Chris Hostetter <ho...@fucit.org>.
: I believe that the release guide wiki page that Peter started at
: <http://wiki.apache.org/lucy/ReleaseGuide> is now feature-complete and ready
: for either review or use.

+1

My one comment is that while i'm certain each release will contain README 
files and documentation on how to "use" Lucy, it would be helpful if there 
were more docs on how to "verify" that a Lucy release "looks good" -- 
things that people would do during the "Perform whatever quality control 
seems prudent on the .tar.gz file" step if they are the RM, and during the 
"Call a release vote on the dev list" if you are a PPMC or IPMC member.

i think it makes total sense for this to be a distinct wiki page from the 
ReleaseGuide (ReleseVerificationChecklist maybe?) becuase the burden 
shouldn't be on the release manager to verify everything; and it makes 
sense to be brief about the things that generally need checked for all 
apache releases (license files, pgp/md5 sigs check out, etc...) but 
anything Lucyd specific ("run the unit tests like so...", "build and test 
the CPAN artifacts like so...", etc...) would be good list to have on the 
wiki.


-Hoss

Re: [lucy-dev] ReleaseGuide wiki page draft done

Posted by Marvin Humphrey <ma...@rectangular.com>.
On Sun, Jan 09, 2011 at 09:59:05PM -0600, Peter Karman wrote:
> Peter Karman wrote on 1/9/11 8:58 PM:
> > Marvin Humphrey wrote on 1/9/11 1:09 PM:
> >> The guide currently refers to certain resources that do not yet exist:
> >>
> >>     trunk/devel/bin/update_version
> > 
> > I will work on this.
> > 
> 
> done in r1057078.
> 
> Let me know if the approach is way off target.

Looks great!  Thanks, Peter!

Marvin Humphrey

Re: [lucy-dev] ReleaseGuide wiki page draft done

Posted by Peter Karman <pe...@peknet.com>.
Peter Karman wrote on 1/9/11 8:58 PM:
> Marvin Humphrey wrote on 1/9/11 1:09 PM:
>> The guide currently refers to certain resources that do not yet exist:
>>
>>     trunk/devel/bin/update_version
> 
> I will work on this.
> 

done in r1057078.

Let me know if the approach is way off target.

-- 
Peter Karman  .  http://peknet.com/  .  peter@peknet.com

Re: [lucy-dev] ReleaseGuide wiki page draft done

Posted by Peter Karman <pe...@peknet.com>.
Marvin Humphrey wrote on 1/9/11 1:09 PM:

> 
> The idea is that first-time release managers must familiarize themselves with
> the issues involved by consulting expansive Apache documentation, but once
> that preparation has been completed and the RM is up-to-speed, our release
> guide serves as a succinct enumeration of the actions required to perform a
> release -- hopefully just as useful on the third or fourth go-round as on the
> first.

+1 I like this approach.

Thanks for finishing that piece, Marvin.

> 
> The guide currently refers to certain resources that do not yet exist:
> 
>     trunk/devel/bin/update_version

I will work on this.

-- 
Peter Karman  .  http://peknet.com/  .  peter@peknet.com