releasenotes: add custom admonitions support for release notes

By default, the extension has default sections like fix, feature, perf etc.. This
patch allow user to add support for custom admonition. In order to add a custom
admonition, one needs to have a .hgreleasenotes file inside the repository. All the
custom directive with name specified under the tag [sections] will be
usable by the extension. One important thing to keep in mind is if there exists any
custom admonitions with same key as default then they will override the default ones.

hgext/releasenotes.py

@@ -20,10 +20,12 @@ import textwrap
 
 from mercurial.i18n import _
 from mercurial import (
+    config,
     error,
     minirst,
     registrar,
     scmutil,
+    util,
 )
 
 cmdtable = {}
@@ -111,9 +113,15 @@ class parsedreleasenotes(object):
                 self.addnontitleditem(section, paragraphs)
 
 class releasenotessections(object):
-    def __init__(self, ui):
-        # TODO support defining custom sections from config.
-        self._sections = list(DEFAULT_SECTIONS)
+    def __init__(self, ui, repo=None):
+        if repo:
+            sections = util.sortdict(DEFAULT_SECTIONS)
+            custom_sections = getcustomadmonitions(repo)
+            if custom_sections:
+                sections.update(custom_sections)
+            self._sections = list(sections.iteritems())
+        else:
+            self._sections = list(DEFAULT_SECTIONS)
 
     def __iter__(self):
         return iter(self._sections)
@@ -128,6 +136,22 @@ class releasenotessections(object):
 
         return None
 
+def getcustomadmonitions(repo):
+    ctx = repo['.']
+    p = config.config()
+
+    def read(f, sections=None, remap=None):
+        if f in ctx:
+            data = ctx[f].data()
+            p.parse(f, data, sections, remap, read)
+        else:
+            raise error.Abort(_(".hgreleasenotes file \'%s\' not found") %
+                              repo.pathto(f))
+
+    if '.hgreleasenotes' in ctx:
+        read('.hgreleasenotes')
+    return p['sections']
+
 def parsenotesfromrevisions(repo, directives, revs):
     notes = parsedreleasenotes()
 
@@ -396,7 +420,7 @@ def releasenotes(ui, repo, file_, rev=None):
     that file. A particular use case for this is to tweak the wording of a
     release note after it has been added to the release notes file.
     """
-    sections = releasenotessections(ui)
+    sections = releasenotessections(ui, repo)
 
     revs = scmutil.revrange(repo, [rev or 'not public()'])
     incoming = parsenotesfromrevisions(repo, sections.names(), revs)
@@ -416,7 +440,7 @@ def releasenotes(ui, repo, file_, rev=None):
         fh.write(serializenotes(sections, notes))
 
 @command('debugparsereleasenotes', norepo=True)
-def debugparsereleasenotes(ui, path):
+def debugparsereleasenotes(ui, path, repo=None):
     """parse release notes and print resulting data structure"""
     if path == '-':
         text = sys.stdin.read()
@@ -424,7 +448,7 @@ def debugparsereleasenotes(ui, path):
         with open(path, 'rb') as fh:
             text = fh.read()
 
-    sections = releasenotessections(ui)
+    sections = releasenotessections(ui, repo)
 
     notes = parsereleasenotesfile(sections, text)
 

tests/test-releasenotes-formatting.t

@@ -255,6 +255,8 @@ Now add bullet points to sections having sub-sections
   
   * Short summary of fix 3
 
+  $ cd ..
+
 Multiple 'Other Changes' sub-sections for every section
 
   $ hg init multiple-otherchanges
@@ -324,3 +326,53 @@ Multiple 'Other Changes' sub-sections for every section
   
   * Short summary of fix 2
 
+  $ cd ..
+
+Using custom sections in notes
+
+  $ hg init custom-section
+  $ cd custom-section
+  $ cat >> .hgreleasenotes << EOF
+  > [sections]
+  > testsection=Name of Section
+  > EOF
+
+  $ touch a
+  $ hg -q commit -A -l - << EOF
+  > commit 1
+  > 
+  > .. testsection::
+  > 
+  >    First paragraph under this admonition.
+  > EOF
+
+  $ hg releasenotes -r . $TESTTMP/relnotes-custom-section
+  $ cat $TESTTMP/relnotes-custom-section
+  Name of Section
+  ===============
+  
+  * First paragraph under this admonition.
+
+Overriding default sections (For eg. by default feature = New Features)
+
+  $ cat >> .hgreleasenotes << EOF
+  > [sections]
+  > feature=Feature Additions
+  > EOF
+
+  $ touch b
+  $ hg -q commit -A -l - << EOF
+  > commit 2
+  > 
+  > .. feature::
+  > 
+  >    Adds a new feature.
+  > EOF
+
+  $ hg releasenotes -r . $TESTTMP/relnotes-override-section
+  $ cat $TESTTMP/relnotes-override-section
+  Feature Additions
+  =================
+  
+  * Adds a new feature.
+