Patchwork D6332: releasenotes: add a file in which to record release-notes

login
register
mail settings
Submitter phabricator
Date May 2, 2019, 4:04 a.m.
Message ID <differential-rev-PHID-DREV-ccptu4dia5yb6v7lcyon-req@phab.mercurial-scm.org>
Download mbox | patch
Permalink /patch/39920/
State Superseded
Headers show

Comments

phabricator - May 2, 2019, 4:04 a.m.
martinvonz created this revision.
Herald added a subscriber: mercurial-devel.
Herald added a reviewer: hg-reviewers.

REVISION SUMMARY
  I've just spent a few very boring hours going through the changelog
  for the 5.0 release (829 commits). We only had 5 commits that used the
  syntax that the release notes extension expects. This commit adds a
  file in which we can record important changes. The file should
  preferably be edited in the patch that makes the important change, but
  it can also be edited after (I think this is an important benefit
  compared to the release notes extension).
  
  I'm thinking that we can rename the file from "next" to "5.1" or
  something when it's time, and then we'd create a new "next" file on
  the default branch.
  
  I've used the syntax that we use on the our wiki in the template, but
  I don't care much that we use any valid syntax at all. The idea is
  mostly to record important changes when they happen. I expect that
  some copy editing will be needed at release time anyway.

REPOSITORY
  rHG Mercurial

REVISION DETAIL
  https://phab.mercurial-scm.org/D6332

AFFECTED FILES
  release-notes/next

CHANGE DETAILS




To: martinvonz, #hg-reviewers
Cc: mercurial-devel
phabricator - May 2, 2019, 4:05 a.m.
martinvonz added a comment.


  I'd be fine if this was queued as is, but it's mostly just to hear what others think

REPOSITORY
  rHG Mercurial

REVISION DETAIL
  https://phab.mercurial-scm.org/D6332

To: martinvonz, #hg-reviewers
Cc: mercurial-devel
phabricator - May 2, 2019, 8:26 a.m.
Sietse added a comment.


  I think this is a fine idea -- it is more robust, because it does not depend on getting the commit syntax right, but on knowing the right place. It also means commit messages (for developers, one per commit) don't have to do double duty as release notes (for users, one per functional change).
  
  When this patch is accepted, one could make this policy visible by adding an "Update release notes" section to the https://www.mercurial-scm.org/wiki/ContributingChanges checklist.

REPOSITORY
  rHG Mercurial

REVISION DETAIL
  https://phab.mercurial-scm.org/D6332

To: martinvonz, #hg-reviewers
Cc: Sietse, mercurial-devel
phabricator - May 2, 2019, 8:57 a.m.
marmoute added a comment.


  +1 on the idea of an explcit editable file instead of immutable static entry in the changelog. I would use it.
  
  The main issue emerging from this kind of approach are the conflict in that file.  There are multiple way to smooth that out.

REPOSITORY
  rHG Mercurial

REVISION DETAIL
  https://phab.mercurial-scm.org/D6332

To: martinvonz, #hg-reviewers
Cc: marmoute, Sietse, mercurial-devel

Patch

diff --git a/release-notes/next b/release-notes/next
new file mode 100644
--- /dev/null
+++ b/release-notes/next
@@ -0,0 +1,10 @@ 
+== New Features ==
+
+
+== Bug Fixes  ==
+
+
+== Backwards Compatibility Changes ==
+
+
+== Internal API Changes ==