[Zope3-dev] Re: Automated egg releases

[Stephan Richter]

On Wednesday 26 September 2007 10:19, Philipp von Weitershausen wrote:

> > I, for one, promise to read it every time I make a release until I've
> > memorized it.
>
> It would be good if everybody could use it (as least the section on how
> to make releases) as a step-by-step procedure every time. I certainly do
> this now and as far as I remember, back in the one-big-tarball days, we
> all did using the MakingARelease wiki page.

Yep, and even then people forgot steps. I won't point fingers -- but it was 
not you. ;-)

> * That setup.py sdist should be run from a **clean** checkout of
>    the tag that you just created. That avoids
>
>    - forgetting to tag or tagging the wrong thing (happened to me
>      and others)
>
>    - forgetting to clean up the 'build' directory (happened to me
>      and my egg contained old stuff that shouldn't have been in there)
>
>    - forgetting to check in files; setuptools will only include package
>      data files that are in subversion (happened to me and other people)

I think this is a bad idea. Often I do not notice problems till I create the 
distribution. I actually upload the release first and create the tag for it 
later. Clearly this is a problem if multiple people work on a project, but I 
would not worry about that in our case. Doing another checkout of the tag 
will create a significant overhead to the release process of a package.

> * That you should check if the long_description renders as proper
>    reStructuredText before you update the PyPI page (reST errors will
>    cause the rendering to be all messed up.

The biggest problem here is that PyPI does not correctly escape HTML in the 
ReST document. I had to escape the REST documents in several projects to not 
have a total mess.

Regards,
Stephan
-- 
Stephan Richter
CBU Physics & Chemistry (B.S.) / Tufts Physics (Ph.D. student)
Web2k - Web Software Design, Development and Training