Summary

Add support for posting with Markdown-formatted commit messages.

Review Request #5211 — Created Jan. 7, 2014 and submitted Jan. 13, 2014, 6:10 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

master

Bugs

Depends On

~~5223~~

Reviewers

Groups

rbtools

People

Description

Add support for posting with Markdown-formatted commit messages.

This adds a new option --markdown option to rbt post which prevents
escaping of content within the commit message for the description. This
prevents the need to unescape the description before publishing if the
commit message is considered Markdown-safe, or if it's otherwise
Markdown-formatted.

There's also a MARKDOWN option for .reviewboardrc that can be set to
enable this by default.

This only works for Review Board 2.0+. For now, it may cause an error
when using it with older versions. We'll likely want to introduce a
capability and make use of it.

Testing Done

Posted this change, and didn't touch the Description field.

Issues

Description	From	Last Updated
You also need to check that tool.capabilities is not None.	david	Jan. 13, 2014, 6:10 p.m.

This looks OK, but I'm not comfortable with it without having the capability.

Change Summary:


Made use of the new capability in /r/5223.
Moved this onto the master branch.

Branch:

release-0.5.x

master

Depends On:

~~5223 - Add a Markdown capability for the web API.~~

Diff:

Revision 2 (+24)

Show changes

	docs/rbtools/rbt/commands/post.txt
	rbtools/commands/post.py

rbtools/commands/post.py (Diff revisions 1 - 2)

The issue has been dropped. Show all issues

You also need to check that tool.capabilities is not None.

chipx86 Jan. 9, 2014, 9:25 p.m.

I believe post always has tool.capabilities. We create one regardless of the existence of the resource.

We also have another capability check for base_commit_id, which doesn't check if it's None.

david Jan. 9, 2014, 10:47 p.m.

Well, the SCMTool ctor defaults capabilities to None, and other places that look at capabilities do something like:

if (self.capabilities and
    self.capabilities.has_capability('diffs', 'moved_files')):

chipx86 Jan. 13, 2014, 1:35 a.m.

Right, the bits of API and SCMClients don't assume they have it, because it's up to the command to decide it's worth initializing it (since it's another API request). The post command always initializes by calling setup_tool, which is what creates the capabilities instance (whether or not an equivalent exists on the server). Commands are safe to assume there's an object if they call setup_tool.

david Jan. 13, 2014, 2:02 p.m.
```
OK. Ship it.
```

Status:: Completed