zest.releaser updates wrong CHANGES.txt about zest.releaser HOT 7 CLOSED

One workaround would be to keep your eggs outside your buildout directory, probably best by setting eggs-directory=/some/other/dir within a ~/.buildout/default.cfg file. Another would be to move docs/HISTORY.txt to the top level directory. Yesterday I moved several packages from the Plone subversion collective to github. Any docs/HISTORY.txt files I renamed to CHANGES.rst in the top level directory.

Now some possible solutions.

I think svn info always contacts the central server, so it would take far too long to do this for every file. Doing an svn ls once, and only checking those files could work. For git git ls-tree -r HEAD --name-only seems to be the way to go. For mercurial: hg manifest. For bazaar: bzr ls --recursive This sounds like a clean solution.

Another option would be to add a few blacklisted directories, at least eggs and parts. We probably want to do an extra check for those: if there is an __init__.py file inside, then it may be a legitimate directory to look inside. Someone may be working on a package x.eggs or y.parts.

A third option would be to remove our special handling of the docs directory. We check this directory last, because some packages may only have a docs/HISTORY.txt that was autogenerated and the real history file is in package/name/HISTORY.txt. But that can be considered an error by the owner of the package: if the file is not used, it should be removed. So we could decide to treat the docs directory normally, which would help in your case.

@reinout: got a preference?

from zest.releaser.

I like the third option. Add a note "you should cleanup and probably move to CHANGES.rst anyway".

Those old autogenerated docs/HISTORY.txt files ought to be pretty rare nowadays :-)

from zest.releaser.

Well, I think some paster/ZopeSkel templates create that file by default. Printing such a warning note when we find this file, may be too much. The only time this is a problem, is when the real HISTORY.txt is somewhere in a deeper directory. If there is a CHANGES.rst/txt or HISTORY.txt in the top level directory, this is found first anyway.

from zest.releaser.

Hi

On Thu, Sep 13, 2012 at 7:36 AM, Maurits van Rees
[email protected]:

I think svn info always contacts the central server, so it would take far
too long to do this for every file.

"svn diff" with a local file and no revision spec, on the other hand, never
contacts the central server, and returns a non-zero exit-code for non-repo
files. We just need to take care to correctly redirect the output so as not
to print it or hang on lack of buffer space.

IMHO, removing the "docs" special ordering, or adding" eggs", etc.. special
cases would only delay the next issue report where an unexpected directory
layout would trip the changelog detection.

from zest.releaser.

I went for the first option anyway, so svn ls, git ls-tree, etcetera. See c0aec5b

And I print a warning when more than one changes/history/version file was found: 3c7f2fa

Any comments?

from zest.releaser.

On Tue, Sep 25, 2012 at 12:36 PM, Maurits van Rees <[email protected]

wrote:

I went for the first option anyway, so svn ls, git ls-tree, etcetera. See
c0aec5bhttps://github.com/zestsoftware/zest.releaser/commit/c0aec5b9be972759ecbd402f023609ccc9e2fb22

And I print a warning when more than one changes/history/version file was
found: 3c7f2fahttps://github.com/zestsoftware/zest.releaser/commit/3c7f2fac07b6c80cca1b4678629e3784d8ca26cf

Any comments?

Looks fine by me!

from zest.releaser.

Version 3.39 released.

from zest.releaser.