Sfoglia il codice sorgente

new proposal: formal release notes

this integrates the ideas in #214 to have a small checklist of things to send in the announcements on the mailing list and on the github release
Antoine Beaupré 9 anni fa
parent
commit
4dca50fafa
1 ha cambiato i file con 13 aggiunte e 4 eliminazioni
  1. 13 4
      docs/development.rst

+ 13 - 4
docs/development.rst

@@ -113,18 +113,27 @@ Checklist::
   cd docs ; make html
 
 - update website with the html (XXX: how?)
-- create a release on PyPi::
+- write a release notes announcement, with:
+
+  1. a single summary paragraph, outlining major changes, security
+     issues, or deprecation warnings, and generally the severity of
+     the release, with a pointer to ``CHANGES.rst``
+  2. instructions for installing and upgrading borg (pointers to the
+     regular install docs, except for new installation/upgrade methods)
+  3. known issues (to be updated as we go along)
+
+- create a release on PyPi with the above release notes::
 
     python setup.py register sdist upload --identity="Thomas Waldmann" --sign
 
-- close release milestone on Github
-- announce on::
+- announce the release notes on::
 
   - `mailing list <mailto:borgbackup@librelist.org>`_
   - Twitter (XXX: how? where?)
   - `IRC channel <irc://irc.freenode.net/borgbackup>`_ (change ``/topic``
 
-- create standalone binaries (see below) and upload them to the Github release
+- create standalone binaries (see below)
+- upload standalone binaries to the Github release, integrate release notes
 
 
 Creating standalone binaries