refactor(test-utils): deprecate the isDockerDisabledForTests function

Signed-off-by: Camila Belo <camilaibs@gmail.com>

.changeset/forty-buttons-cover.md

@@ -0,0 +1,5 @@
+---
+'@backstage/backend-test-utils': patch
+---
+
+The function `isDockerDisabledForTests` is deprecated and will no longer be exported in the near future as it should only be used internally.

packages/backend-test-utils/api-report.md

@@ -54,7 +54,7 @@ export interface CreateMockDirectoryOptions {
   mockOsTmpDir?: boolean;
 }
 
-// @public (undocumented)
+// @public @deprecated (undocumented)
 export function isDockerDisabledForTests(): boolean;
 
 // @public (undocumented)

packages/backend-test-utils/src/deprecated.ts

@@ -15,9 +15,18 @@
  */
 
 import { CreateMockDirectoryOptions } from './filesystem';
+import { isDockerDisabledForTests as _isDockerDisabledForTests } from './util';
 
 /**
  * @public
  * @deprecated Use `CreateMockDirectoryOptions` from `@backstage/backend-test-utils` instead.
  */
 export type MockDirectoryOptions = CreateMockDirectoryOptions;
+
+/**
+ * @public
+ * @deprecated This is an internal function and will no longer be exported from this package.
+ */
+export function isDockerDisabledForTests(): boolean {
+  return _isDockerDisabledForTests();
+}

packages/backend-test-utils/src/index.ts

@@ -26,4 +26,3 @@ export * from './database';
 export * from './msw';
 export * from './filesystem';
 export * from './next';
-export * from './util';

packages/backend-test-utils/src/util/isDockerDisabledForTests.ts

@@ -14,7 +14,6 @@
  * limitations under the License.
  */
 
-/** @public */
 export function isDockerDisabledForTests() {
   // If we are not running in continuous integration, the default is to skip
   // the (relatively heavy, long running) docker based tests. If you want to