Summary

Fix building docs for release-5.0.x

Review Request #12370 — Created June 14, 2022 and submitted June 16, 2022, 2:41 p.m.

Information

Owner

david

Repository

Review Board

Branch

release-5.0.x

Bugs

Depends On

Reviewers

Groups

reviewboard

People

Description

The new SCMTools registry work caused a problem trying to build docs.
The issue was that we were using AppConfig.ready to populate the
registry, but doing so will do some database accesses (in order to pull
any legacy Tool instances that don't exist in entry points into the
registry). According to the documentation for ready, we should avoid
doing any DB queries here, precisely because it can affect running
management commands.

This change moves the registry population back into a handler for the
initializing signal, along with a comment explaining why.

While it's apparently not necessary for the docs build, I've also added
the new scmtool_id field to the fixtures for the docs DB.

Testing Done


Ran unit tests.
Built docs.

Commits

Summary	ID
Fix building docs for release-5.0.x The new SCMTools registry work caused a problem trying to build docs. The issue was that we were using `AppConfig.ready` to populate the registry, but doing so will do some database accesses (in order to pull any legacy Tool instances that don't exist in entry points into the registry). According to the documentation for `ready`, we should avoid doing any DB queries here, precisely because it can affect running management commands. This change moves the registry population back into a handler for the `initializing` signal, along with a comment explaining why. While it's apparently not necessary for the docs build, I've also added the new `scmtool_id` field to the fixtures for the docs DB. Testing Done: - Ran unit tests. - Built docs.	b34e273ffbabd64430cc38e040da9ed724d1ec13

Summary

Fix building docs for release-5.0.x

The new SCMTools registry work caused a problem trying to build docs. The issue was that we were using `AppConfig.ready` to populate the registry, but doing so will do some database accesses (in order to pull any legacy Tool instances that don't exist in entry points into the registry). According to the documentation for `ready`, we should avoid doing any DB queries here, precisely because it can affect running management commands. This change moves the registry population back into a handler for the `initializing` signal, along with a comment explaining why. While it's apparently not necessary for the docs build, I've also added the new `scmtool_id` field to the fixtures for the docs DB. Testing Done: - Ran unit tests. - Built docs.

b34e273ffbabd64430cc38e040da9ed724d1ec13

Issues

Description	From	Last Updated
Missing the Args: docs.	chipx86	June 16, 2022, 1:25 p.m.
Could put a Version Added in here	maubin	June 16, 2022, 1:25 p.m.

flake8 passed.

JSHint passed.

reviewboard/scmtools/__init__.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Could put a Version Added in here
```

reviewboard/scmtools/__init__.py (Diff revision 1)
The issue has been resolved. Show all issues
```
Missing the Args: docs.
```

Description:

		The new SCMTools registry work caused a problem trying to build docs.
		The issue was that we were using `AppConfig.ready` to populate the
		registry, but doing so will do some database accesses (in order to pull
		any legacy Tool instances that don't exist in entry points into the
		registry). According to the documentation for `ready`, we should avoid
		doing any DB queries here, precisely because it can affect running
		management commands.

		This change moves the registry population back into a handler for the
		`initializing` signal, along with a comment explaining why.

		While it's apparently not necessary for the docs build, I've also added
		the new `scmtool_id` field to the fixtures for the docs DB.
-
-		Testing Done:
-		- Ran unit tests.
-		- Built docs.

Testing Done:

	+	Ran unit tests.
	+	Built docs.

Commits:

	Summary	ID
	Fix building docs for release-5.0.x The new SCMTools registry work caused a problem trying to build docs. The issue was that we were using `AppConfig.ready` to populate the registry, but doing so will do some database accesses (in order to pull any legacy Tool instances that don't exist in entry points into the registry). According to the documentation for `ready`, we should avoid doing any DB queries here, precisely because it can affect running management commands. This change moves the registry population back into a handler for the `initializing` signal, along with a comment explaining why. While it's apparently not necessary for the docs build, I've also added the new `scmtool_id` field to the fixtures for the docs DB. Testing Done: - Ran unit tests. - Built docs.	675a9f386b9ede77d89b4673340b44a8be87912f
	Fix building docs for release-5.0.x The new SCMTools registry work caused a problem trying to build docs. The issue was that we were using `AppConfig.ready` to populate the registry, but doing so will do some database accesses (in order to pull any legacy Tool instances that don't exist in entry points into the registry). According to the documentation for `ready`, we should avoid doing any DB queries here, precisely because it can affect running management commands. This change moves the registry population back into a handler for the `initializing` signal, along with a comment explaining why. While it's apparently not necessary for the docs build, I've also added the new `scmtool_id` field to the fixtures for the docs DB. Testing Done: - Ran unit tests. - Built docs.	b34e273ffbabd64430cc38e040da9ed724d1ec13

Diff:

Revision 2 (+60 -56)

Show changes

	docs/manual/fixtures/initial_data.json
	reviewboard/scmtools/__init__.py
	reviewboard/scmtools/apps.py

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

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