Summary

Enhance the JSON output for rbt status and clean up some non-standard code.

Review Request #12177 — Created March 18, 2022 and submitted March 21, 2022, 10:08 p.m.

Information

Owner

chipx86

Repository

RBTools

Branch

release-3.x

Bugs

Depends On

Reviewers

Groups

rbtools

People

Description

This enhances the results of rbt status --json to show additional
information useful for automation.

The results are now in a review_requests key, instead of summaries,
which better identifies the type of results and allows for enhancement
in the future.

The review request ID (review_request_id) and URL
(review_request_url) are now provided, instead of just the ID.

The results also now include has_draft, shipit_count,
open_issue_count, approved, and approval_failure fields, which are
more useful for tools that may want to wrap this command.

It also cleans up some of the code to use more standard terminology
("review request" instead of "request" or "review"), and to fix
documentation and spacing.

Testing Done

Tested rbt status --json and saw the revised fields.

Commits

Summary	ID
Enhance the JSON output for rbt status and clean up some non-standard code. This enhances the results of `rbt status --json` to show additional information useful for automation. The results are now in a `review_requests` key, instead of `summaries`, which better identifies the type of results and allows for enhancement in the future. The review request ID (`review_request_id`) and URL (`review_request_url`) are now provided, instead of just the ID. The results also now include `has_draft`, `shipit_count`, `open_issue_count`, `approved`, and `approval_failure` fields, which are more useful for tools that may want to wrap this command. It also cleans up some of the code to use more standard terminology ("review request" instead of "request" or "review"), and to fix documentation and spacing.	cd77998c21a5952f9143cbf6ecd5645c160f09d0

Summary

Enhance the JSON output for rbt status and clean up some non-standard code.

This enhances the results of `rbt status --json` to show additional information useful for automation. The results are now in a `review_requests` key, instead of `summaries`, which better identifies the type of results and allows for enhancement in the future. The review request ID (`review_request_id`) and URL (`review_request_url`) are now provided, instead of just the ID. The results also now include `has_draft`, `shipit_count`, `open_issue_count`, `approved`, and `approval_failure` fields, which are more useful for tools that may want to wrap this command. It also cleans up some of the code to use more standard terminology ("review request" instead of "request" or "review"), and to fix documentation and spacing.

cd77998c21a5952f9143cbf6ecd5645c160f09d0

flake8 passed.

JSHint passed.

Change Summary:

Renamed the summaries key to review_requests.

Description:

		This enhances the results of `rbt status --json` to show both a review
		request ID (`review_request_id`) and URL (`review_request_url`).

	+	The results are now in a `review_requests` key, instead of `summaries`,
	+	which better identifies the type of results and allows for enhancement
	+	in the future.
	+
		It also cleans up some of the code to use more standard terminology
		("review request" instead of "request" or "review"), and to fix
		documentation and spacing.

Commits:

	Summary	ID
	Enhance the JSON output for rbt status and clean up some non-standard code. This enhances the results of `rbt status --json` to show both a review request ID (`review_request_id`) and URL (`review_request_url`). It also cleans up some of the code to use more standard terminology ("review request" instead of "request" or "review"), and to fix documentation and spacing.	cdf6aa4d1499ec96a17c8cf63540bec2c8252842
	Enhance the JSON output for rbt status and clean up some non-standard code. This enhances the results of `rbt status --json` to show both a review request ID (`review_request_id`) and URL (`review_request_url`). The results are now in a `review_requests` key, instead of `summaries`, which better identifies the type of results and allows for enhancement in the future. It also cleans up some of the code to use more standard terminology ("review request" instead of "request" or "review"), and to fix documentation and spacing.	f17d2b38e8d0d7a69f8d039fd88f6b425f04ca34

Diff:

Revision 2 (+66 -56)

Show changes

rbtools/commands/status.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Added approved and approval_failure info to the JSON payload.

Description:

~		This enhances the results of `rbt status --json` to show both a review
~		request ID (`review_request_id`) and URL (`review_request_url`).
	~	This enhances the results of `rbt status --json` to show additional
	~	information useful for automation.

		The results are now in a `review_requests` key, instead of `summaries`,
		which better identifies the type of results and allows for enhancement
		in the future.

	+	The review request ID (`review_request_id`) and URL
	+	(`review_request_url`) are now provided, instead of just the ID.
	+
	+	The results also now include `has_draft`, `shipit_count`,
	+	`open_issue_count`, `approved`, and `approval_failure` fields, which are
	+	more useful for tools that may want to wrap this command.
	+
		It also cleans up some of the code to use more standard terminology
		("review request" instead of "request" or "review"), and to fix
		documentation and spacing.

Commits:

	Summary	ID
	Enhance the JSON output for rbt status and clean up some non-standard code. This enhances the results of `rbt status --json` to show both a review request ID (`review_request_id`) and URL (`review_request_url`). The results are now in a `review_requests` key, instead of `summaries`, which better identifies the type of results and allows for enhancement in the future. It also cleans up some of the code to use more standard terminology ("review request" instead of "request" or "review"), and to fix documentation and spacing.	f17d2b38e8d0d7a69f8d039fd88f6b425f04ca34
	Enhance the JSON output for rbt status and clean up some non-standard code. This enhances the results of `rbt status --json` to show additional information useful for automation. The results are now in a `review_requests` key, instead of `summaries`, which better identifies the type of results and allows for enhancement in the future. The review request ID (`review_request_id`) and URL (`review_request_url`) are now provided, instead of just the ID. The results also now include `has_draft`, `shipit_count`, `open_issue_count`, `approved`, and `approval_failure` fields, which are more useful for tools that may want to wrap this command. It also cleans up some of the code to use more standard terminology ("review request" instead of "request" or "review"), and to fix documentation and spacing.	7c00910c7e5088ed77839a61d6568a8f0b381b02

Diff:

Revision 3 (+80 -58)

Show changes

rbtools/commands/status.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Failed to actually git add the new changes.

Commits:

	Summary	ID
	Enhance the JSON output for rbt status and clean up some non-standard code. This enhances the results of `rbt status --json` to show additional information useful for automation. The results are now in a `review_requests` key, instead of `summaries`, which better identifies the type of results and allows for enhancement in the future. The review request ID (`review_request_id`) and URL (`review_request_url`) are now provided, instead of just the ID. The results also now include `has_draft`, `shipit_count`, `open_issue_count`, `approved`, and `approval_failure` fields, which are more useful for tools that may want to wrap this command. It also cleans up some of the code to use more standard terminology ("review request" instead of "request" or "review"), and to fix documentation and spacing.	7c00910c7e5088ed77839a61d6568a8f0b381b02
	Enhance the JSON output for rbt status and clean up some non-standard code. This enhances the results of `rbt status --json` to show additional information useful for automation. The results are now in a `review_requests` key, instead of `summaries`, which better identifies the type of results and allows for enhancement in the future. The review request ID (`review_request_id`) and URL (`review_request_url`) are now provided, instead of just the ID. The results also now include `has_draft`, `shipit_count`, `open_issue_count`, `approved`, and `approval_failure` fields, which are more useful for tools that may want to wrap this command. It also cleans up some of the code to use more standard terminology ("review request" instead of "request" or "review"), and to fix documentation and spacing.	cd77998c21a5952f9143cbf6ecd5645c160f09d0

Diff:

Revision 4 (+88 -58)

Show changes

rbtools/commands/status.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.x (1c475e4)