@backstage/cli 0.34.4-next.3 → 0.34.5-next.0

package/CHANGELOG.md

@@ -1,5 +1,76 @@
 # @backstage/cli
 
+## 0.34.5-next.0
+
+### Patch Changes
+
+- fc7cbfc: The templates executed with the `yarn new` command now supports templating filenames.
+- fc7cbfc: Added a template for the `yarn new` command to create an catalog entity provider. To add this template to an explicit list in the root `package.json`, use `@backstage/cli/templates/catalog-provider-module`.
+- 05f60e1: Refactored constructor parameter properties to explicit property declarations for compatibility with TypeScript's `erasableSyntaxOnly` setting. This internal refactoring maintains all existing functionality while ensuring TypeScript compilation compatibility.
+- Updated dependencies
+  - @backstage/eslint-plugin@0.2.0-next.0
+  - @backstage/config-loader@1.10.6-next.0
+  - @backstage/config@1.3.6-next.0
+  - @backstage/cli-node@0.2.15-next.0
+  - @backstage/catalog-model@1.7.6-next.0
+  - @backstage/integration@1.18.2-next.0
+  - @backstage/cli-common@0.1.15
+  - @backstage/errors@1.2.7
+  - @backstage/release-manifests@0.0.13
+  - @backstage/types@1.2.2
+
+## 0.34.4
+
+### Patch Changes
+
+- f2cf564: Removed the script transform cache from the default Jest configuration. The script cache provided a moderate performance boost, but it is incompatible with Jest 30.
+- 33faad2: Allow using custom manifest location in the yarn plugin and version bump.
+
+  The Backstage yarn plugin and version bump allows two new environment variables to configure custom manifest location:
+
+  - `BACKSTAGE_VERSIONS_BASE_URL`: The base URL for fetching the Backstage version
+    manifest. Defaults to `https://versions.backstage.io/v1/releases/VERSION/manifest.json`.
+    Useful for running the plugin in environment without direct access to the internet,
+    for example by using a mirror of the versions API or a proxy.
+    Note that the environment variable is just the host name, and the path is appended by
+    the plugin. If you are using the yarn plugin, bump version command will also try
+    to fetch the new version of the yarn plugin from the same base URL (defaults to
+    `https://versions.backstage.io/v1/releases/RELEASE/yarn-plugin`)
+  - `BACKSTAGE_MANIFEST_FILE`: Path to a local manifest file. If set, the plugin
+    will not attempt to fetch the manifest from the network. Useful for running
+    the plugin in environment without internet access and without mirror of the
+    versions API.
+
+- 6ebc1ea: Fixed module federation config by only setting `import: false` on shared libraries for remote.
+- ab96bb7: Added a new `--entrypoint` option to the `package start` command, which allows you to specify a custom entry directory/file for development applications. This is particularly useful when maintaining separate dev apps for different versions of your plugin (e.g., stable and alpha).
+
+  **Example usage:**
+
+  Consider the following plugin dev folder structure:
+
+  ```
+  dev/
+    index.tsx
+    alpha/
+      index.ts
+  ```
+
+  - The default `yarn package start` command uses the `dev/` folder as the entry point and executes `dev/index.tsx` file;
+  - Running `yarn package start --entrypoint dev/alpha` will instead use `dev/alpha/` as the entry point and execute `dev/alpha/index.ts` file.
+
+- 024645e: Remove unused @octokit modules from cli package
+
+  - @octokit/graphql
+  - @octokit/graphql-schema
+  - @octokit/oauth-app
+
+- d14ef24: Added automatic detection and support for the Backstage Yarn plugin when generating new packages with `yarn new`. When the plugin is installed, new packages will automatically use `backstage:^` ranges for `@backstage/*` dependencies.
+- Updated dependencies
+  - @backstage/eslint-plugin@0.1.12
+  - @backstage/integration@1.18.1
+  - @backstage/config-loader@1.10.5
+  - @backstage/config@1.3.5
+
 ## 0.34.4-next.3
 
 ### Patch Changes

package/dist/lib/versioning/Lockfile.cjs.js

@@ -28,11 +28,6 @@ const SPECIAL_OBJECT_KEYS = [
   `binaries`
 ];
 class Lockfile {
-  constructor(packages, data, legacy = false) {
-    this.packages = packages;
-    this.data = data;
-    this.legacy = legacy;
-  }
   static async load(path) {
     const lockfileContents = await fs__default.default.readFile(path, "utf8");
     return Lockfile.parse(lockfileContents);
@@ -69,6 +64,14 @@ class Lockfile {
     }
     return new Lockfile(packages, data, legacy);
   }
+  packages;
+  data;
+  legacy;
+  constructor(packages, data, legacy = false) {
+    this.packages = packages;
+    this.data = data;
+    this.legacy = legacy;
+  }
   /** Get the entries for a single package in the lockfile */
   get(name) {
     return this.packages.get(name);

package/dist/modules/create-github-app/commands/create-github-app/GithubCreateAppServer.cjs.js

@@ -25,12 +25,6 @@ const FORM_PAGE = `
 </html>
 `;
 class GithubCreateAppServer {
-  constructor(actionUrl, permissions) {
-    this.actionUrl = actionUrl;
-    this.permissions = permissions;
-    const webhookId = crypto__default.default.randomBytes(15).toString("base64").replace(/[\+\/]/g, "");
-    this.webhookUrl = `https://smee.io/${webhookId}`;
-  }
   baseUrl;
   webhookUrl;
   static async run(options) {
@@ -39,6 +33,14 @@ class GithubCreateAppServer {
     const server = new GithubCreateAppServer(actionUrl, options.permissions);
     return server.start();
   }
+  actionUrl;
+  permissions;
+  constructor(actionUrl, permissions) {
+    this.actionUrl = actionUrl;
+    this.permissions = permissions;
+    const webhookId = crypto__default.default.randomBytes(15).toString("base64").replace(/[\+\/]/g, "");
+    this.webhookUrl = `https://smee.io/${webhookId}`;
+  }
   async start() {
     const app = express__default.default();
     app.get("/", this.formHandler);

package/dist/modules/migrate/commands/versions/bump.cjs.js

@@ -2,6 +2,7 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+var process$1 = require('process');
 var fs = require('fs-extra');
 var chalk = require('chalk');
 var minimatch = require('minimatch');
@@ -65,7 +66,12 @@ var bump = async (opts) => {
   }
   let findTargetVersion;
   let releaseManifest;
-  if (semver__default.default.valid(opts.release)) {
+  if (process$1.env.BACKSTAGE_MANIFEST_FILE) {
+    releaseManifest = await fs__default.default.readJson(process$1.env.BACKSTAGE_MANIFEST_FILE);
+    findTargetVersion = createStrictVersionFinder({
+      releaseManifest
+    });
+  } else if (semver__default.default.valid(opts.release)) {
     releaseManifest = await releaseManifests.getManifestByVersion({ version: opts.release });
     findTargetVersion = createStrictVersionFinder({
       releaseManifest
@@ -73,15 +79,18 @@ var bump = async (opts) => {
   } else {
     if (opts.release === "next") {
       const next = await releaseManifests.getManifestByReleaseLine({
-        releaseLine: "next"
+        releaseLine: "next",
+        versionsBaseUrl: process$1.env.BACKSTAGE_VERSIONS_BASE_URL
       });
       const main = await releaseManifests.getManifestByReleaseLine({
-        releaseLine: "main"
+        releaseLine: "main",
+        versionsBaseUrl: process$1.env.BACKSTAGE_VERSIONS_BASE_URL
       });
       releaseManifest = semver__default.default.gt(next.releaseVersion, main.releaseVersion) ? next : main;
     } else {
       releaseManifest = await releaseManifests.getManifestByReleaseLine({
-        releaseLine: opts.release
+        releaseLine: opts.release,
+        versionsBaseUrl: process$1.env.BACKSTAGE_VERSIONS_BASE_URL
       });
     }
     findTargetVersion = createVersionFinder({
@@ -95,11 +104,8 @@ var bump = async (opts) => {
       `Updating yarn plugin to v${releaseManifest.releaseVersion}...`
     );
     console.log();
-    await run.run("yarn", [
-      "plugin",
-      "import",
-      `https://versions.backstage.io/v1/releases/${releaseManifest.releaseVersion}/yarn-plugin`
-    ]);
+    const yarnPluginUrl = process$1.env.BACKSTAGE_VERSIONS_BASE_URL ? `${process$1.env.BACKSTAGE_VERSIONS_BASE_URL}/v1/releases/${releaseManifest.releaseVersion}/yarn-plugin` : `https://versions.backstage.io/v1/releases/${releaseManifest.releaseVersion}/yarn-plugin`;
+    await run.run("yarn", ["plugin", "import", yarnPluginUrl]);
     console.log();
   }
   const dependencyMap = await packages.mapDependencies(paths.paths.targetDir, pattern);

package/dist/modules/new/lib/defaultTemplates.cjs.js

@@ -9,6 +9,7 @@ const defaultTemplates = [
   "@backstage/cli/templates/plugin-common-library",
   "@backstage/cli/templates/web-library",
   "@backstage/cli/templates/node-library",
+  "@backstage/cli/templates/catalog-provider-module",
   "@backstage/cli/templates/scaffolder-backend-module"
 ];
 

package/dist/modules/new/lib/execution/writeTemplateContents.cjs.js

@@ -6,6 +6,7 @@ var paths = require('../../../../lib/paths.cjs.js');
 var errors = require('@backstage/errors');
 var cliNode = require('@backstage/cli-node');
 var PortableTemplater = require('./PortableTemplater.cjs.js');
+var cliCommon = require('@backstage/cli-common');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -42,7 +43,12 @@ async function writeTemplateContents(template, input) {
       );
     }
     for (const file of template.files) {
-      const destPath = path.resolve(targetDir, file.path);
+      const destPath = path.resolve(targetDir, templater.template(file.path));
+      if (!cliCommon.isChildPath(targetDir, destPath)) {
+        throw new Error(
+          `Path ${destPath} is outside of target directory ${targetDir}`
+        );
+      }
       await fs__default.default.ensureDir(path.dirname(destPath));
       let content = file.syntax === "handlebars" ? templater.template(file.content) : file.content;
       if (file.path === "package.json") {

package/dist/packages/backend-defaults/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.13.0-next.2";
+var version = "0.13.1-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/backend-plugin-api/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.4.4-next.0";
+var version = "1.4.5-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/backend-test-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.9.1-next.1";
+var version = "1.10.0-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/catalog-client/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.12.0";
+var version = "1.12.1-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/cli/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.34.4-next.3";
+var version = "0.34.5-next.0";
 var dependencies = {
 	"@backstage/catalog-model": "workspace:^",
 	"@backstage/cli-common": "workspace:^",

package/dist/packages/config/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.3.5-next.0";
+var version = "1.3.6-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/core-app-api/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.19.1-next.0";
+var version = "1.19.2-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/core-components/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.18.2-next.3";
+var version = "0.18.3-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/core-plugin-api/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.11.1-next.0";
+var version = "1.11.2-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/dev-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.1.15-next.2";
+var version = "1.1.17-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/frontend-defaults/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.3.2-next.1";
+var version = "0.3.3-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/frontend-plugin-api/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.12.1-next.2";
+var version = "0.12.2-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/frontend-test-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.3.7-next.1";
+var version = "0.4.1-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/test-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.7.12-next.1";
+var version = "1.7.13-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/packages/theme/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.6.9-next.0";
+var version = "0.7.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/auth-backend/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.25.5-next.0";
+var version = "0.25.6-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/auth-backend-module-guest-provider/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.2.13-next.0";
+var version = "0.2.14-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/catalog-node/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "1.19.1-next.0";
+var version = "1.19.2-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/scaffolder-node/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.12.0-next.1";
+var version = "0.12.1-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/dist/plugins/scaffolder-node-test-utils/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.3.4-next.1";
+var version = "0.3.5-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/cli",
-  "version": "0.34.4-next.3",
+  "version": "0.34.5-next.0",
   "description": "CLI for developing Backstage plugins and apps",
   "backstage": {
     "role": "cli"
@@ -47,14 +47,14 @@
     ]
   },
   "dependencies": {
-    "@backstage/catalog-model": "1.7.5",
+    "@backstage/catalog-model": "1.7.6-next.0",
     "@backstage/cli-common": "0.1.15",
-    "@backstage/cli-node": "0.2.14",
-    "@backstage/config": "1.3.5-next.0",
-    "@backstage/config-loader": "1.10.5-next.0",
+    "@backstage/cli-node": "0.2.15-next.0",
+    "@backstage/config": "1.3.6-next.0",
+    "@backstage/config-loader": "1.10.6-next.0",
     "@backstage/errors": "1.2.7",
-    "@backstage/eslint-plugin": "0.1.11",
-    "@backstage/integration": "1.18.1-next.1",
+    "@backstage/eslint-plugin": "0.2.0-next.0",
+    "@backstage/integration": "1.18.2-next.0",
     "@backstage/release-manifests": "0.0.13",
     "@backstage/types": "1.2.2",
     "@manypkg/get-packages": "^1.1.3",
@@ -151,22 +151,22 @@
     "zod-validation-error": "^3.4.0"
   },
   "devDependencies": {
-    "@backstage/backend-plugin-api": "1.4.4-next.0",
-    "@backstage/backend-test-utils": "1.9.1-next.1",
-    "@backstage/catalog-client": "1.12.0",
-    "@backstage/config": "1.3.5-next.0",
-    "@backstage/core-app-api": "1.19.1-next.0",
-    "@backstage/core-components": "0.18.2-next.3",
-    "@backstage/core-plugin-api": "1.11.1-next.0",
-    "@backstage/dev-utils": "1.1.15-next.2",
+    "@backstage/backend-plugin-api": "1.4.5-next.0",
+    "@backstage/backend-test-utils": "1.10.0-next.0",
+    "@backstage/catalog-client": "1.12.1-next.0",
+    "@backstage/config": "1.3.6-next.0",
+    "@backstage/core-app-api": "1.19.2-next.0",
+    "@backstage/core-components": "0.18.3-next.0",
+    "@backstage/core-plugin-api": "1.11.2-next.0",
+    "@backstage/dev-utils": "1.1.17-next.0",
     "@backstage/errors": "1.2.7",
-    "@backstage/plugin-auth-backend": "0.25.5-next.0",
-    "@backstage/plugin-auth-backend-module-guest-provider": "0.2.13-next.0",
-    "@backstage/plugin-catalog-node": "1.19.1-next.0",
-    "@backstage/plugin-scaffolder-node": "0.12.0-next.1",
-    "@backstage/plugin-scaffolder-node-test-utils": "0.3.4-next.1",
-    "@backstage/test-utils": "1.7.12-next.1",
-    "@backstage/theme": "0.6.9-next.0",
+    "@backstage/plugin-auth-backend": "0.25.6-next.0",
+    "@backstage/plugin-auth-backend-module-guest-provider": "0.2.14-next.0",
+    "@backstage/plugin-catalog-node": "1.19.2-next.0",
+    "@backstage/plugin-scaffolder-node": "0.12.1-next.0",
+    "@backstage/plugin-scaffolder-node-test-utils": "0.3.5-next.0",
+    "@backstage/test-utils": "1.7.13-next.0",
+    "@backstage/theme": "0.7.0",
     "@pmmmwh/react-refresh-webpack-plugin": "^0.5.7",
     "@types/cross-spawn": "^6.0.2",
     "@types/ejs": "^3.1.3",

package/templates/catalog-provider-module/.eslintrc.js.hbs

@@ -0,0 +1 @@
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);

package/templates/catalog-provider-module/README.md.hbs

@@ -0,0 +1,5 @@
+# {{packageName}}
+
+The {{fullModuleId}} module for [@backstage/plugin-catalog-backend](https://www.npmjs.com/package/@backstage/plugin-catalog-backend).
+
+_This plugin was created through the Backstage CLI_

package/templates/catalog-provider-module/config.d.ts.hbs

@@ -0,0 +1,34 @@
+import { SchedulerServiceTaskScheduleDefinitionConfig } from '@backstage/backend-plugin-api';
+
+export interface Config {
+  catalog?: {
+    providers?: {
+      /**
+       * {{providerClass}} configuration.
+       */
+      {{providerVar}}?:
+        | {
+            /**
+             * The target that this provider should consume.
+             */
+            target: string;
+            /**
+             * Overrides the schedule at which this provider runs.
+             */
+            schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
+          }
+        | {
+            [name: string]: {
+              /**
+               * The target that this provider should consume.
+               */
+              target: string;
+              /**
+               * Overrides the schedule at which this provider runs.
+               */
+              schedule?: SchedulerServiceTaskScheduleDefinitionConfig;
+            };
+          };
+    };
+  };
+}

package/templates/catalog-provider-module/package.json.hbs

@@ -0,0 +1,36 @@
+{
+  "name": "{{packageName}}",
+  "description": "The {{fullModuleId}} module for @backstage/plugin-catalog-backend",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "publishConfig": {
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "backend-plugin-module",
+    "pluginId": "catalog",
+    "pluginPackage": "@backstage/plugin-catalog-backend"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "dependencies": {
+    "@backstage/backend-plugin-api": "{{versionQuery '@backstage/backend-plugin-api'}}",
+    "@backstage/plugin-catalog-node": "{{versionQuery '@backstage/plugin-catalog-node'}}"
+  },
+  "devDependencies": {
+    "@backstage/cli": "{{versionQuery '@backstage/cli'}}",
+    "@backstage/backend-test-utils": "{{versionQuery '@backstage/backend-test-utils'}}"
+  },
+  "files": [
+    "dist"
+  ]
+}

package/templates/catalog-provider-module/portable-template.yaml

@@ -0,0 +1,9 @@
+name: catalog-provider-module
+role: backend-plugin-module
+description: An Entity Provider module for the Software Catalog
+values:
+  pluginId: catalog
+  fullModuleId: '{{ moduleId }}-provider'
+  moduleVar: '{{ camelCase pluginId }}Module{{ upperFirst ( camelCase moduleId ) }}'
+  providerVar: '{{ camelCase moduleId }}Provider'
+  providerClass: '{{ upperFirst ( camelCase moduleId ) }}Provider'

package/templates/catalog-provider-module/src/index.ts.hbs

@@ -0,0 +1,8 @@
+/***/
+/**
+ * The {{fullModuleId}} module for @backstage/plugin-catalog-backend
+ *
+ * @packageDocumentation
+ */
+
+export { {{moduleVar}} as default } from './module';

package/templates/catalog-provider-module/src/module.ts.hbs

@@ -0,0 +1,29 @@
+import {
+  coreServices,
+  createBackendModule,
+} from '@backstage/backend-plugin-api';
+import { catalogProcessingExtensionPoint } from '@backstage/plugin-catalog-node/alpha';
+import { {{providerClass}} } from './provider/{{providerClass}}';
+
+export const {{moduleVar}} = createBackendModule({
+  moduleId: '{{fullModuleId}}',
+  pluginId: '{{pluginId}}',
+  register({ registerInit }) {
+    registerInit({
+      deps: {
+        logger: coreServices.logger,
+        config: coreServices.rootConfig,
+        scheduler: coreServices.scheduler,
+        processing: catalogProcessingExtensionPoint,
+      },
+      async init({ logger, scheduler, config, processing }) {
+        processing.addEntityProvider(
+          {{providerClass}}.fromConfig(config, {
+            logger,
+            scheduler,
+          }),
+        );
+      }
+    });
+  },
+})

package/templates/catalog-provider-module/src/provider/readProviderConfigs.ts.hbs

@@ -0,0 +1,78 @@
+import {
+  readSchedulerServiceTaskScheduleDefinitionFromConfig,
+  SchedulerServiceTaskScheduleDefinition,
+} from '@backstage/backend-plugin-api';
+import { Config } from '@backstage/config';
+
+const DEFAULT_PROVIDER_ID = 'default';
+const DEFAULT_SCHEDULE: SchedulerServiceTaskScheduleDefinition = {
+  frequency: {
+    minutes: 30,
+  },
+  timeout: {
+    minutes: 3,
+  },
+}
+
+export type {{providerClass}}ProviderConfig = {
+  id: string;
+  target: string;
+  schedule: SchedulerServiceTaskScheduleDefinition;
+}
+
+/**
+ * Parses all configured providers.
+ *
+ * @param config - The root of the provider config hierarchy
+ *
+ * @public
+ */
+export function readProviderConfigs(
+  config: Config,
+): {{providerClass}}ProviderConfig[] {
+  const providersConfig = config.getOptionalConfig(
+    'catalog.providers.{{providerVar}}',
+  );
+  if (!providersConfig) {
+    return [];
+  }
+
+  if ((providersConfig).has('target')) {
+    // simple/single config variant
+    return [readProviderConfig(DEFAULT_PROVIDER_ID, providersConfig)];
+  }
+
+  return providersConfig.keys().map(id => {
+    const providerConfig = providersConfig.getConfig(id);
+
+    return readProviderConfig(id, providerConfig);
+  });
+}
+
+/**
+ * Parses a single configured provider by id.
+ *
+ * @param id - the id of the provider to parse
+ * @param config - The root of the provider config hierarchy
+ *
+ * @public
+ */
+export function readProviderConfig(
+  id: string,
+  config: Config,
+): {{providerClass}}ProviderConfig {
+
+  const target = config.getString('target');
+
+  const schedule = config.has('schedule')
+    ? readSchedulerServiceTaskScheduleDefinitionFromConfig(
+        config.getConfig('schedule'),
+      )
+    : DEFAULT_SCHEDULE;
+
+  return {
+    id,
+    target,
+    schedule,
+  };
+}

package/templates/catalog-provider-module/src/provider/{{providerClass}}.test.ts.hbs

@@ -0,0 +1,18 @@
+import { {{providerClass}} } from './{{providerClass}}';
+import { mockServices } from '@backstage/backend-test-utils';
+
+describe('{{providerClass}}', () => {
+  it('should read entities from the target', async () => {
+    const logger = mockServices.logger.mock();
+    const provider = new {{providerClass}}({
+      id: 'test',
+      target: 'https://example.com',
+      logger: mockServices.logger.mock(),
+      taskRunner: { run: jest.fn() },
+    });
+
+    const entities = await provider.read({ logger });
+
+    expect(entities).toEqual([]);
+  });
+})

package/templates/catalog-provider-module/src/provider/{{providerClass}}.ts.hbs

@@ -0,0 +1,109 @@
+import { Config } from '@backstage/config';
+import {
+  DeferredEntity,
+  EntityProvider,
+  EntityProviderConnection,
+} from '@backstage/plugin-catalog-node';
+import * as uuid from 'uuid';
+import { readProviderConfigs } from './readProviderConfigs';
+import {
+  LoggerService,
+  SchedulerService,
+  SchedulerServiceTaskRunner,
+} from '@backstage/backend-plugin-api';
+
+export type {{providerClass}}Options = {
+  /**
+   * The logger to use.
+   */
+  logger: LoggerService;
+
+  /**
+   * Scheduler used to schedule refreshes based on
+   * the schedule config.
+   */
+  scheduler: SchedulerService;
+};
+
+export class {{providerClass}} implements EntityProvider {
+  static fromConfig(
+    configRoot: Config,
+    options: {{providerClass}}Options,
+  ): {{providerClass}}[] {
+    return readProviderConfigs(configRoot).map(providerConfig => {
+      return new {{providerClass}}({
+        id: providerConfig.id,
+        target: providerConfig.target,
+        logger: options.logger,
+        taskRunner: options.scheduler.createScheduledTaskRunner(
+          providerConfig.schedule,
+        ),
+      });
+    });
+  }
+
+  readonly #id: string;
+  readonly #target: string;
+  readonly #logger: LoggerService;
+  readonly #taskRunner: SchedulerServiceTaskRunner;
+
+  constructor(options: {
+    id: string;
+    target: string;
+    logger: LoggerService;
+    taskRunner: SchedulerServiceTaskRunner;
+  }) {
+    this.#id = options.id;
+    this.#target = options.target;
+    this.#logger = options.logger;
+    this.#taskRunner = options.taskRunner;
+  }
+
+  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.getProviderName} */
+  getProviderName() {
+    return `{{providerClass}}:${this.#id}`;
+  }
+
+  /** {@inheritdoc @backstage/plugin-catalog-node#EntityProvider.connect} */
+  async connect(connection: EntityProviderConnection) {
+    const id = `${this.getProviderName()}:refresh`;
+
+    // Schedule a refresh task to be run periodically
+    await this.#taskRunner.run({
+      id,
+      fn: async () => {
+        const logger = this.#logger.child({
+          taskId: id,
+          taskInstanceId: uuid.v4(),
+        });
+
+        try {
+          const entities = await this.read({ logger });
+
+          logger.info(`Read ${entities.length} entities`);
+
+          await connection.applyMutation({
+            type: 'full',
+            entities,
+          });
+        } catch (error) {
+          logger.error(`Refresh failed`, error);
+        }
+      },
+    });
+  }
+
+  /**
+   * Reads entities to be added to the catalog.
+   */
+  async read(options: { logger: LoggerService }): Promise<DeferredEntity[]> {
+    const { logger } = options;
+
+    logger.info(`Reading entities from ${this.#target}`);
+
+    // TODO: Implement entity reading logic from the target
+    const entities: DeferredEntity[] = [];
+
+    return entities;
+  }
+}