Summary

Add support for publishing with a message

Review Request #7763 — Created Nov. 9, 2015 and submitted Dec. 11, 2015, 5:04 p.m.

Information

Owner

brennie

Repository

RBTools

Branch

master

Bugs

Depends On

~~7762~~

Commit

8854e97...

Reviewers

Groups

rbtools

People

Description

Both rbt post and rbt publish can now publish with a change

description. This change description supports markdown via the

--markdown flag used for summaries and descriptions.
Providing a change description before the review request is public will

not result in an error; instead the option will be ignored and an

informative message will be displayed to the user.
The publish command now also only fetches the required links and

fields when publishing to minimize the amount of data that is

transmitted.

Testing Done


Published with a message.
Verified that rbt publish -m provided an error message when the

  review request was not public.

Issues

Description	From	Last Updated
Can we have it so that this doesn't imply --publish, but just sets the text of the change description? I …	david	Nov. 23, 2015, 5:50 p.m.
What happens if I specify this for a review request which is not yet public?	david	Nov. 24, 2015, 1:10 p.m.
This could be much simpler: Publish the review request immediately after posting, but without sending an e-mail notification.	david	Nov. 24, 2015, 9:40 p.m.
How about "The change description field can only be set when publishing an update. Use --description instead."	david	Nov. 24, 2015, 9:41 p.m.
"Publish without sending an e-mail notification"?	david	Nov. 24, 2015, 9:40 p.m.
Same here about recommending --description? Perhaps we should make these fail instead of just log?	david	Nov. 24, 2015, 9:41 p.m.

Tool: Pyflakes
Processed Files:
    rbtools/commands/post.py
    rbtools/commands/publish.py



Tool: PEP8 Style Checker
Processed Files:
    rbtools/commands/post.py
    rbtools/commands/publish.py

Change Summary:

Add depends-on

Depends On:

~~7762 - Add support for trivial publishing~~

Diff:

Revision 2 (+43 -4)

Show changes

	rbtools/commands/post.py
	rbtools/commands/publish.py

Tool: Pyflakes
Processed Files:
    rbtools/commands/post.py
    rbtools/commands/publish.py



Tool: PEP8 Style Checker
Processed Files:
    rbtools/commands/post.py
    rbtools/commands/publish.py

rbtools/commands/post.py (Diff revision 2)

The issue has been resolved. Show all issues

Can we have it so that this doesn't imply --publish, but just sets the text of the change description? I can see a use case for wanting to set it when posting but wanting to review before publishing, and it's easy enough to do -p -m XXX.

It might make sense to also name the long option --change-description so that it matches up with the help for --markdown below.

rbtools/commands/post.py (Diff revision 2)

The issue has been resolved. Show all issues

What happens if I specify this for a review request which is not yet public?

brennie Nov. 23, 2015, 5:53 p.m.
```
It will end up as an API error.
```

david Nov. 24, 2015, 11:21 a.m.

Can we show something nicer to the user?

Commit:

883431bd8aafae68e4a0ee8f5843a9bf56829c17

Diff:

Revision 3 (+75 -8)

Show changes

	rbtools/commands/post.py
	rbtools/commands/publish.py

Tool: PEP8 Style Checker
Processed Files:
    rbtools/commands/post.py
    rbtools/commands/publish.py



Tool: Pyflakes
Processed Files:
    rbtools/commands/post.py
    rbtools/commands/publish.py

Change Summary:

Address David's issues.

Description:

		Both `rbt post` and `rbt publish` can now publish with a change
		description. This change description supports markdown via the
		`--markdown` flag used for summaries and descriptions.
	+
	+	Providing a change description before the review request is public will
	+	not result in an error; instead the option will be ignored and an
	+	informative message will be displayed to the user.
	+
	+	The `publish` command now also only fetches the required links and
	+	fields when publishing to minimize the amount of data that is
	+	transmitted.

Testing Done:

~		Published with a message.
	~	Published with a message.
	+	Verified that `rbt publish -m` provided an error message when the review request was not public.

Diff:

Revision 4 (+93 -12)

Show changes

	rbtools/commands/post.py
	rbtools/commands/publish.py

Tool: Pyflakes
Processed Files:
    rbtools/commands/post.py
    rbtools/commands/publish.py



Tool: PEP8 Style Checker
Processed Files:
    rbtools/commands/post.py
    rbtools/commands/publish.py

rbtools/commands/post.py (Diff revision 4)

The issue has been resolved. Show all issues

This could be much simpler:

Publish the review request immediately after posting, but without sending an e-mail notification.

rbtools/commands/post.py (Diff revision 4)

The issue has been resolved. Show all issues

How about "The change description field can only be set when publishing an update. Use --description instead."

rbtools/commands/publish.py (Diff revision 4)
The issue has been resolved. Show all issues
```
"Publish without sending an e-mail notification"?
```

rbtools/commands/publish.py (Diff revision 4)

The issue has been resolved. Show all issues

Same here about recommending --description? Perhaps we should make these fail instead of just log?

Change Summary:

Don't reccomend rbt publish --description. There is no such flag.

Commit:

883431bd8aafae68e4a0ee8f5843a9bf56829c17

8854e97b3250f0fc01fd3f05ab3179342bdda4e0

Diff:

Revision 5 (+60 -17)

Show changes

	rbtools/commands/post.py
	rbtools/commands/publish.py

Tool: Pyflakes
Processed Files:
    rbtools/commands/post.py
    rbtools/commands/publish.py



Tool: PEP8 Style Checker
Processed Files:
    rbtools/commands/post.py
    rbtools/commands/publish.py

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to master (673ca4e)