This is an archive of the discontinued Mercurial Phabricator instance.

Differential D355

contrib: add check flag for use of admonitions and its validity
AbandonedPublic

Authored by rishabhmadan96 on Aug 11 2017, 6:42 PM.

Details

Reviewers
pulkit
Group Reviewers
hg-reviewers
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.

Diff Detail

Repository
rHG Mercurial
Lint
Lint Skipped
Unit
Unit Tests Skipped

Event Timeline

rishabhmadan96 created this revision.Aug 11 2017, 6:42 PM
pulkit added a subscriber: pulkit.Aug 12 2017, 1:56 PM

Can you add tests for this. Also the commit message starts with "contrib", which seems unrelated here, please correct that.

hgext/releasenotes.py
543

You can do return checkadmonitions(...) and that will prevent the later spacing diff.

pulkit requested changes to this revision.Aug 12 2017, 1:57 PM
This revision now requires changes to proceed.Aug 12 2017, 1:57 PM
durin42 added a subscriber: durin42.Aug 15 2017, 1:09 PM

is this the same thing as D368? Should we close this one in favor of that one?

rishabhmadan96 marked an inline comment as done.Aug 15 2017, 1:53 PM
rishabhmadan96 abandoned this revision.
In D355#6196, @durin42 wrote:

is this the same thing as D368? Should we close this one in favor of that one?

Yes. I'm abandoning this one.

Revision Contents
Changeset List

PathPackages
Mhgext/releasenotes.py (58 lines)

Diff 816

hgext/releasenotes.py

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\
\n") % (admonition.group(1), ctx.hex()[:12]))
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'):
checkadmonitions(ui, repo, sections.names(), revs)
pulkitUnsubmitted
Done

You can do return checkadmonitions(...) and that will prevent the later spacing diff.

pulkit: You can do `return checkadmonitions(...)` and that will prevent the later spacing diff.
if not opts.get('check'):
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
notes = parsedreleasenotes() notes = parsedreleasenotes()
notes.merge(ui, incoming) notes.merge(ui, incoming)
with open(file_, 'wb') as fh: with open(file_, 'wb') as fh:
fh.write(serializenotes(sections, notes)) fh.write(serializenotes(sections, notes))
@command('debugparsereleasenotes', norepo=True) @command('debugparsereleasenotes', norepo=True)
def debugparsereleasenotes(ui, path, repo=None): def debugparsereleasenotes(ui, path, repo=None):
"""parse release notes and print resulting data structure""" """parse release notes and print resulting data structure"""
if path == '-': if path == '-':
text = sys.stdin.read() text = sys.stdin.read()
else: else:
with open(path, 'rb') as fh: with open(path, 'rb') as fh: