[asdf-devel] Release notes

[Faré]

On Thu, Mar 13, 2014 at 2:30 PM, Robert P. Goldman <rpgoldman at sift.info> wrote:
> Stelian Ionescu wrote:
>> [...]
>>> > Every release comes with release notes that mention changes to the API.
>>> > I haven't announced changes with every commit, because that would be verbose,
>>> > and people who're interested can already read the git log.
>>
>> Where are the release notes ? asdf-3.0.3.tar.gz(a tar bomb) contains no
>> such thing, nor the git repository.
>
> That's a good point.  There is a pretty comprehensive changelog, but
> it's buried in the debian/ subdirectory.
>
> There's always been a release announcement emailed out, but that isn't
> included in the tarball.
>
The debian/changelog is a pretty good approximation of a release notes file:
a debian package is issued once per release, modulo packaging bugs or
critical bugs necessitating immediate re-release, and has had essentially
the same contents as my release notes, ever since 2.011 or so.

> I'll try to improve our practice here.  Proposal: before releasing I
> will put release notes into the top ASDF directory.  These will be the
> same as what goes in the email message.  I'll also make sure there's a
> copy of the changelog at the top level, with a cross-reference.
>
> Subscribers to ASDF-devel will be urged to review these and suggest
> improvements, before the release is made official.
>
> Does this sound like a reasonable process?
>
Sounds OK to me. I would have just kept editing the debian/changelog,
and did just push a change to the README pointing to it.
But it's your choice, you're the maintainer.

—♯ƒ • François-René ÐVB Rideau •Reflection&Cybernethics• http://fare.tunes.org
Life is a sexually transmitted disease with 100% mortality.