Summary

Create a new extension hook for hiding built-in actions.

Review Request #12963 — Created April 20, 2023 and submitted April 25, 2023, 11:42 a.m.

Information

Owner

david

Repository

Review Board

Branch

release-6.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

Testing Done


Ran unit tests.
Verified correctness of behavior with a small extension that hid the

  support menu and ship-it action.
Built docs and checked the output.

Commits

Summary	ID
Create a new extension hook for hiding built-in actions. One thing extensions authors like to do on occasion is either hide or replace built-in functionality. For example, some servers have disabled the support menu or replaced the quick ship-it action with one that does some custom behavior first. This change adds an official extension hook to enable this without having to patch the code. Testing Done: - Ran unit tests. - Verified correctness of behavior with a small extension that hid the support menu and ship-it action. - Built docs and checked the output.	082b53f6ee88ea92131a8f090728196a36124312

Summary

Create a new extension hook for hiding built-in actions.

One thing extensions authors like to do on occasion is either hide or replace built-in functionality. For example, some servers have disabled the support menu or replaced the quick ship-it action with one that does some custom behavior first. This change adds an official extension hook to enable this without having to patch the code. Testing Done: - Ran unit tests. - Verified correctness of behavior with a small extension that hid the support menu and ship-it action. - Built docs and checked the output.

082b53f6ee88ea92131a8f090728196a36124312

Issues

Description	From	Last Updated
local variable 'hook' is assigned to but never used Column: 9 Error code: F841	reviewbot	April 20, 2023, 10:24 a.m.
I know this is pretty self explanatory but I think it'd still be good to say something like "Simply initialize …	maubin	April 21, 2023, 4:14 p.m.
Missing the rest of the sentence here.	maubin	April 21, 2023, 4:14 p.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/extensions/tests/test_action_hooks.py (Diff revision 1)
The issue has been dropped. Show all issues
```
local variable 'hook' is assigned to but never used

Column: 9
Error code: F841
```

Commits:

	Summary	ID
	Create a new extension hook for hiding built-in actions. One thing extensions authors like to do on occasion is either hide or replace built-in functionality. For example, some servers have disabled the support menu or replaced the quick ship-it action with one that does some custom behavior first. This change adds an official extension hook to enable this without having to patch the code. Testing Done: - Ran unit tests. - Verified correctness of behavior with a small extension that hid the support menu and ship-it action. - Built docs and checked the output.	d64380dbfb691e8e34c2aa798bd67f71b57dbabe
	Create a new extension hook for hiding built-in actions. One thing extensions authors like to do on occasion is either hide or replace built-in functionality. For example, some servers have disabled the support menu or replaced the quick ship-it action with one that does some custom behavior first. This change adds an official extension hook to enable this without having to patch the code. Testing Done: - Ran unit tests. - Verified correctness of behavior with a small extension that hid the support menu and ship-it action. - Built docs and checked the output.	e1a0300f402989648f1adca79293dc1670a998c1

Diff:

Revision 2 (+194)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/extensions/hooks/action-hooks.rst
	reviewboard/actions/base.py
	reviewboard/extensions/hooks/__init__.py
	reviewboard/extensions/hooks/actions.py
	reviewboard/extensions/tests/test_action_hooks.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

docs/manual/extending/extensions/hooks/action-hooks.rst (Diff revision 2)

The issue has been resolved. Show all issues

I know this is pretty self explanatory but I think it'd still be good to say something like "Simply initialize the hook with a list of :py:attr:~reviewboard.actions.base.BaseAction.action_ids of the actions that you want to hide."

reviewboard/actions/base.py (Diff revision 2)
The issue has been resolved. Show all issues
```
Missing the rest of the sentence here.
```

Commits:

	Summary	ID
	Create a new extension hook for hiding built-in actions. One thing extensions authors like to do on occasion is either hide or replace built-in functionality. For example, some servers have disabled the support menu or replaced the quick ship-it action with one that does some custom behavior first. This change adds an official extension hook to enable this without having to patch the code. Testing Done: - Ran unit tests. - Verified correctness of behavior with a small extension that hid the support menu and ship-it action. - Built docs and checked the output.	e1a0300f402989648f1adca79293dc1670a998c1
	Create a new extension hook for hiding built-in actions. One thing extensions authors like to do on occasion is either hide or replace built-in functionality. For example, some servers have disabled the support menu or replaced the quick ship-it action with one that does some custom behavior first. This change adds an official extension hook to enable this without having to patch the code. Testing Done: - Ran unit tests. - Verified correctness of behavior with a small extension that hid the support menu and ship-it action. - Built docs and checked the output.	082b53f6ee88ea92131a8f090728196a36124312

Diff:

Revision 3 (+202)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/extensions/hooks/action-hooks.rst
	reviewboard/actions/base.py
	reviewboard/extensions/hooks/__init__.py
	reviewboard/extensions/hooks/actions.py
	reviewboard/extensions/tests/test_action_hooks.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-6.x (77e15b5)