Summary

Add a new extension hook for registering SCMTools.

Review Request #12395 — Created June 21, 2022 and submitted June 21, 2022, 3:12 p.m.

Information

Owner

david

Repository

Review Board

Branch

release-5.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

Now that SCMTools are backed by a registry instead of relying entirely
on entry points and the registerscmtools management command, we can
make it easier for extensions to add new ones. This change adds a new
extension hook, SCMToolHook, for doing so. It works very similarly to
the existing hook for hosting services.

Testing Done


Ran unit tests.
Built and reviewed docs.

Commits

Summary	ID
Add a new extension hook for registering SCMTools. Now that SCMTools are backed by a registry instead of relying entirely on entry points and the `registerscmtools` management command, we can make it easier for extensions to add new ones. This change adds a new extension hook, `SCMToolHook`, for doing so. It works very similarly to the existing hook for hosting services. Testing Done: - Ran unit tests. - Built and reviewed docs.	627f310e757b2726b6cc57c29c3caa05032a14cf

Summary

Add a new extension hook for registering SCMTools.

Now that SCMTools are backed by a registry instead of relying entirely on entry points and the `registerscmtools` management command, we can make it easier for extensions to add new ones. This change adds a new extension hook, `SCMToolHook`, for doing so. It works very similarly to the existing hook for hosting services. Testing Done: - Ran unit tests. - Built and reviewed docs.

627f310e757b2726b6cc57c29c3caa05032a14cf

Issues

Description	From	Last Updated
"used for configured repositories" or "used to configure repositories"?	chipx86	June 21, 2022, 1:42 p.m.
Too many "	chipx86	June 21, 2022, 1:42 p.m.
Let's use assertIs here, for completeness.	chipx86	June 21, 2022, 1:43 p.m.

flake8 passed.

JSHint passed.

```
Neat.
```
docs/manual/extending/extensions/hooks/scmtool_hook.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
"used for configured repositories" or "used to configure repositories"?
```
reviewboard/extensions/hooks.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Too many "
```
reviewboard/extensions/tests/test_scmtool_hook.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Let's use assertIs here, for completeness.
```

Commits:

	Summary	ID
	Add a new extension hook for registering SCMTools. Now that SCMTools are backed by a registry instead of relying entirely on entry points and the `registerscmtools` management command, we can make it easier for extensions to add new ones. This change adds a new extension hook, `SCMToolHook`, for doing so. It works very similarly to the existing hook for hosting services. Testing Done: - Ran unit tests. - Built and reviewed docs.	62a6da49ac3296cbab5baf4302e2b2b06b969e17
	Add a new extension hook for registering SCMTools. Now that SCMTools are backed by a registry instead of relying entirely on entry points and the `registerscmtools` management command, we can make it easier for extensions to add new ones. This change adds a new extension hook, `SCMToolHook`, for doing so. It works very similarly to the existing hook for hosting services. Testing Done: - Ran unit tests. - Built and reviewed docs.	627f310e757b2726b6cc57c29c3caa05032a14cf

Diff:

Revision 2 (+234)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/extensions/hooks/hosting-service-hook.rst
	docs/manual/extending/extensions/hooks/index.rst
	docs/manual/extending/extensions/hooks/scmtool_hook.rst
	reviewboard/extensions/hooks.py
	reviewboard/extensions/tests/test_scmtool_hook.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-5.0.x (3fece69)