Update schedule (#2242)

Signed-off-by: Dominika Zemanovicova <dzemanov@redhat.com>

Author: dzemanov

workspaces/scorecard/.changeset/weak-bananas-bake.md

@@ -0,0 +1,5 @@
+---
+'@red-hat-developer-hub/backstage-plugin-scorecard-backend': patch
+---
+
+Updated default schedule for pulling metrics to have `initialDelay` of 1 minute

workspaces/scorecard/app-config.yaml

@@ -159,3 +159,19 @@ permission:
     admin:
       users:
         - name: user:development/guest
+
+# Scorecard development configuration
+scorecard:
+  plugins:
+    jira:
+      open_issues:
+        schedule:
+          frequency: { minutes: 5 }
+          timeout: { minutes: 10 }
+          initialDelay: { seconds: 5 }
+    github:
+      open_prs:
+        schedule:
+          frequency: { minutes: 5 }
+          timeout: { minutes: 10 }
+          initialDelay: { seconds: 5 }

workspaces/scorecard/plugins/scorecard-backend/README.md

@@ -71,6 +71,19 @@ This policy would allow users to read only the GitHub Open PRs metric, while res
 
 The Scorecard plugin collects metrics from third-party data sources using metric providers. The Scorecard node plugin provides `scorecardMetricsExtensionPoint` extension point that is used to connect your backend plugin module that exports custom metrics via metric providers to the Scorecard backend plugin. For detailed information on creating metric providers, see [providers.md](./docs/providers.md).
 
+### Metric Collection Scheduling
+
+The Scorecard plugin automatically collects metrics on a scheduled basis. You can customize the schedule for any metric provider in your `app-config.yaml`. If no schedule is configured, metric providers use the following default schedule:
+
+```yaml
+schedule:
+  frequency: { hours: 1 }
+  timeout: { minutes: 15 }
+  initialDelay: { minutes: 1 }
+```
+
+For more information about schedule configuration options, see the [Metric Collection Scheduling](./docs/providers.md#metric-collection-scheduling) section in providers.md.
+
 ### Available Metric Providers
 
 The following metric providers are available:

workspaces/scorecard/plugins/scorecard-backend/docs/providers.md

@@ -173,6 +173,15 @@ The schedule configuration follows Backstage's `SchedulerServiceTaskScheduleDefi
 
 Make sure the configured schedule stays within provider API rate limits.
 
+If no schedule is configured, metric providers use the following default schedule:
+
+```yaml
+schedule:
+  frequency: { hours: 1 }
+  timeout: { minutes: 15 }
+  initialDelay: { minutes: 1 }
+```
+
 ## Example Metric Providers
 
 The following are examples of existing metric providers that you can reference:

workspaces/scorecard/plugins/scorecard-backend/src/scheduler/tasks/PullMetricsByProviderTask.test.ts

@@ -164,7 +164,7 @@ describe('PullMetricsByProviderTask', () => {
       expect(config).toEqual({
         frequency: { hours: 1 },
         timeout: { minutes: 15 },
-        initialDelay: { seconds: 3 },
+        initialDelay: { minutes: 1 },
       });
     });
 

workspaces/scorecard/plugins/scorecard-backend/src/scheduler/tasks/PullMetricsByProviderTask.ts

@@ -61,7 +61,7 @@ export class PullMetricsByProviderTask implements SchedulerTask {
     {
       frequency: { hours: 1 },
       timeout: { minutes: 15 },
-      initialDelay: { seconds: 3 },
+      initialDelay: { minutes: 1 },
     };
 
   constructor(options: Options, provider: MetricProvider) {