This is an archive of the discontinued Mercurial Phabricator instance.

Differential D368

releasenotes: add check flag for use of admonitions and its validity
ClosedPublic

Authored by rishabhmadan96 on Aug 13 2017, 10:29 AM.

Details

Reviewers
durin42
krbullock
Group Reviewers
hg-reviewers
Commits
rHG6a49c74b1e8f: releasenotes: add check flag for use of admonitions and its validity
Summary

While using releasenotes extension, we will be using admonitions in commit messages.
The check (-c) flag will look for an admonition within the message. If it exists, it will
verify if it is stated under default or custom admonition. The check fails if the
admonition is not present in any of them. It also suggests similar admonitions
in case the admonition is invalid.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

durin42 requested changes to this revision.Aug 15 2017, 1:09 PM
durin42 added a subscriber: durin42.

A style nit, generally +1 and if you get the style nits handled we should be good to go.

hgext/releasenotes.py
266

nit: in a "-quoted string, you can omit \ on '

not a nit: use

("foo"
 "bar")

instead of \ to wrap a multi-line string literal (the concatenation is implicit at module load time).

This revision now requires changes to proceed.Aug 15 2017, 1:09 PM
rishabhmadan96 edited edge metadata.Aug 16 2017, 1:44 AM
rishabhmadan96 retitled this revision from releasenotes: add check flag for use of admonitions and its validity to Differential Revision: https://phab.mercurial-scm.org/D368 releasenotes: add check flag for use of admonitions and its validity.
rishabhmadan96 updated this revision to Diff 973.
quark added a subscriber: quark.Aug 16 2017, 1:45 AM

Did you add "Differential Revision: https://phab.mercurial-scm.org/D368" to the first line of your commit message? Could you try moving it to the last line?

rishabhmadan96 retitled this revision from Differential Revision: https://phab.mercurial-scm.org/D368 releasenotes: add check flag for use of admonitions and its validity to releasenotes: add check flag for use of admonitions and its validity.Aug 16 2017, 1:46 AM
rishabhmadan96 added a comment.Aug 16 2017, 1:49 AM

Sorry I just edited the revision string. Will that work? Or should I update it again with "Differential Revision: https://phab.mercurial-scm.org/D368" at the end.

quark added a comment.Aug 16 2017, 6:04 PM
In D368#6402, @rishabhmadan96 wrote:

Sorry I just edited the revision string. Will that work? Or should I update it again with "Differential Revision: https://phab.mercurial-scm.org/D368" at the end.

No worries. The title is good now. "Edit Revision" from the web page works. The title can also be updated by "phabsend", which updates the title to be consistent with the commit message.

krbullock accepted this revision.Aug 23 2017, 11:24 AM
krbullock added a subscriber: krbullock.

Looks good, queued!

Closed by commit rHG6a49c74b1e8f: releasenotes: add check flag for use of admonitions and its validity (authored by rishabhmadan96). · Explain WhyAug 23 2017, 11:26 AM
This revision was automatically updated to reflect the committed changes.
pulkit added a subscriber: pulkit.EditedAug 23 2017, 6:08 PM

@rishabhmadan96 Sorry for jumping late, can you followup with a patch adding some docs for the flag. Also document the behavior of hg releasenotes -c and it will be great if you can add a test for this.

Revision Contents
Changeset List

Diff 1200

hgext/releasenotes.py

# Copyright 2017-present Gregory Szorc <gregory.szorc@gmail.com> # Copyright 2017-present Gregory Szorc <gregory.szorc@gmail.com>
# #
# This software may be used and distributed according to the terms of the # This software may be used and distributed according to the terms of the
# GNU General Public License version 2 or any later version. # GNU General Public License version 2 or any later version.
"""generate release notes from commit messages (EXPERIMENTAL) """generate release notes from commit messages (EXPERIMENTAL)
It is common to maintain files detailing changes in a project between It is common to maintain files detailing changes in a project between
releases. Maintaining these files can be difficult and time consuming. releases. Maintaining these files can be difficult and time consuming.
The :hg:`releasenotes` command provided by this extension makes the The :hg:`releasenotes` command provided by this extension makes the
process simpler by automating it. process simpler by automating it.
""" """
from __future__ import absolute_import from __future__ import absolute_import
import difflib
import errno import errno
import re import re
import sys import sys
import textwrap import textwrap
from mercurial.i18n import _ from mercurial.i18n import _
from mercurial import ( from mercurial import (
config, config,
else: else:
raise error.Abort(_(".hgreleasenotes file \'%s\' not found") % raise error.Abort(_(".hgreleasenotes file \'%s\' not found") %
repo.pathto(f)) repo.pathto(f))
if '.hgreleasenotes' in ctx: if '.hgreleasenotes' in ctx:
read('.hgreleasenotes') read('.hgreleasenotes')
return p['sections'] return p['sections']
def checkadmonitions(ui, repo, directives, revs):
"""
Checks the commit messages for admonitions and their validity.
.. abcd::
First paragraph under this admonition
For this commit message, using `hg releasenotes -r . --check`
returns: Invalid admonition 'abcd' present in changeset 3ea92981e103
As admonition 'abcd' is neither present in default nor custom admonitions
"""
for rev in revs:
ctx = repo[rev]
admonition = re.search(RE_DIRECTIVE, ctx.description())
if admonition:
if admonition.group(1) in directives:
continue
else:
ui.write(_("Invalid admonition '%s' present in changeset %s"
durin42Unsubmitted
Not Done

nit: in a "-quoted string, you can omit \ on '

not a nit: use

("foo"
 "bar")

instead of \ to wrap a multi-line string literal (the concatenation is implicit at module load time).

durin42: nit: in a "-quoted string, you can omit \ on ' not a nit: use ("foo" "bar") instead of…
"\n") % (admonition.group(1), ctx.hex()[:12]))
sim = lambda x: difflib.SequenceMatcher(None,
admonition.group(1), x).ratio()
similar = [s for s in directives if sim(s) > 0.6]
if len(similar) == 1:
ui.write(_("(did you mean %s?)\n") % similar[0])
elif similar:
ss = ", ".join(sorted(similar))
ui.write(_("(did you mean one of %s?)\n") % ss)
def parsenotesfromrevisions(repo, directives, revs): def parsenotesfromrevisions(repo, directives, revs):
notes = parsedreleasenotes() notes = parsedreleasenotes()
for rev in revs: for rev in revs:
ctx = repo[rev] ctx = repo[rev]
blocks, pruned = minirst.parse(ctx.description(), blocks, pruned = minirst.parse(ctx.description(),
admonitions=directives) admonitions=directives)
lines.append('') lines.append('')
if lines and lines[-1]: if lines and lines[-1]:
lines.append('') lines.append('')
return '\n'.join(lines) return '\n'.join(lines)
@command('releasenotes', @command('releasenotes',
[('r', 'rev', '', _('revisions to process for release notes'), _('REV'))], [('r', 'rev', '', _('revisions to process for release notes'), _('REV')),
_('[-r REV] FILE')) ('c', 'check', False, _('checks for validity of admonitions (if any)'),
def releasenotes(ui, repo, file_, rev=None): _('REV'))],
_('hg releasenotes [-r REV] [-c] FILE'))
def releasenotes(ui, repo, file_=None, **opts):
"""parse release notes from commit messages into an output file """parse release notes from commit messages into an output file
Given an output file and set of revisions, this command will parse commit Given an output file and set of revisions, this command will parse commit
messages for release notes then add them to the output file. messages for release notes then add them to the output file.
Release notes are defined in commit messages as ReStructuredText Release notes are defined in commit messages as ReStructuredText
directives. These have the form:: directives. These have the form::
greater than a threshold. greater than a threshold.
This means that the release notes file can be updated independently from This means that the release notes file can be updated independently from
this command and changes should not be lost when running this command on this command and changes should not be lost when running this command on
that file. A particular use case for this is to tweak the wording of a 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. release note after it has been added to the release notes file.
""" """
sections = releasenotessections(ui, repo) sections = releasenotessections(ui, repo)
rev = opts.get('rev')
revs = scmutil.revrange(repo, [rev or 'not public()']) revs = scmutil.revrange(repo, [rev or 'not public()'])
if opts.get('check'):
return checkadmonitions(ui, repo, sections.names(), revs)
incoming = parsenotesfromrevisions(repo, sections.names(), revs) incoming = parsenotesfromrevisions(repo, sections.names(), revs)
try: try:
with open(file_, 'rb') as fh: with open(file_, 'rb') as fh:
notes = parsereleasenotesfile(sections, fh.read()) notes = parsereleasenotesfile(sections, fh.read())
except IOError as e: except IOError as e:
if e.errno != errno.ENOENT: if e.errno != errno.ENOENT:
raise raise

tests/test-releasenotes-formatting.t

$ hg releasenotes -r . $TESTTMP/relnotes-override-section $ hg releasenotes -r . $TESTTMP/relnotes-override-section
$ cat $TESTTMP/relnotes-override-section $ cat $TESTTMP/relnotes-override-section
Feature Additions Feature Additions
================= =================
* Adds a new feature. * Adds a new feature.
$ cd ..
Testing output for the --check (-c) flag
$ hg init check-flag
$ cd check-flag
$ touch a
$ hg -q commit -A -l - << EOF
> .. asf::
>
> First paragraph under this admonition.
> EOF
Suggest similar admonition in place of the invalid one.
$ hg releasenotes -r . -c
Invalid admonition 'asf' present in changeset 4026fe9e1c20
$ touch b
$ hg -q commit -A -l - << EOF
> .. fixes::
>
> First paragraph under this admonition.
> EOF
$ hg releasenotes -r . -c
Invalid admonition 'fixes' present in changeset 0e7130d2705c
(did you mean fix?)