@secustor/backstage-plugin-renovate-backend 0.11.1 → 0.13.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @secustor/backstage-plugin-renovate-backend
 
+## 0.13.0
+
+### Minor Changes
+
+- [#413](https://github.com/secustor/backstage-plugins/pull/413) [`6590670`](https://github.com/secustor/backstage-plugins/commit/6590670257a3cac792a8d423f58877925302729b) Thanks [@secustor](https://github.com/secustor)! - Update Backstage to 1.32.1
+
+### Patch Changes
+
+- Updated dependencies [[`6590670`](https://github.com/secustor/backstage-plugins/commit/6590670257a3cac792a8d423f58877925302729b)]:
+  - @secustor/backstage-plugin-renovate-common@0.7.0
+  - @secustor/backstage-plugin-renovate-node@0.4.0
+
+## 0.12.0
+
+### Minor Changes
+
+- [#406](https://github.com/secustor/backstage-plugins/pull/406) [`51225fb`](https://github.com/secustor/backstage-plugins/commit/51225fbfcceb88c22a9882842e4f6adc2430382a) Thanks [@secustor](https://github.com/secustor)! - Allow disabling schedules
+
 ## 0.11.1
 
 ### Patch Changes

package/README.md

@@ -24,6 +24,15 @@ Add the plugin to your Backstage instance:
 backend.add(import('@secustor/backstage-plugin-renovate-backend'));
 ```
 
+Further, you need to add a queue and a runtime implementation.
+
+See the respective plugins for more information:
+
+- [@secustor/backstage-plugin-renovate-backend-module-queue-local](https://www.npmjs.com/package/@secustor/backstage-plugin-renovate-backend-module-queue-local)
+- [@secustor/backstage-plugin-renovate-backend-module-queue-redis](https://www.npmjs.com/package/@secustor/backstage-plugin-renovate-backend-module-queue-redis)
+- [@secustor/backstage-plugin-renovate-backend-module-runtime-direct](https://www.npmjs.com/package/@secustor/backstage-plugin-renovate-backend-module-runtime-direct)
+- [@secustor/backstage-plugin-renovate-backend-module-runtime-docker](https://www.npmjs.com/package/@secustor/backstage-plugin-renovate-backend-module-runtime-docker)
+
 If you wish to install the frontend plugin, you can do so by following the instructions in the frontend plugin's [README](../renovate).
 
 ## Configuration
@@ -42,6 +51,14 @@ backend:
     store: redis
     connection: redis://user:pass@cache.example.com:6379
 
+    cors:
+      # expose paginagtion headers to the frontend
+      exposedHeaders:
+        - x-total-count
+        - x-current-page
+        - x-page-count
+        - x-page-size
+
 renovate:
   cache:
     # Allows turning off cache injection. You can still manually supply caches using the Renovate config
@@ -58,9 +75,11 @@ renovate:
 
   schedules:
     cleanup:
+      # enabled: true  # default value
       frequency: { minutes: 60 }
       timeout: { minutes: 60 }
     renovation:
+      enabled: false # disable schedule. This is useful e.g. for local development
       frequency: { minutes: 60 }
       timeout: { minutes: 60 }
 

package/config.d.ts

@@ -1,5 +1,5 @@
-import { SchedulerServiceTaskScheduleDefinition } from '@backstage/backend-plugin-api';
 import { JsonObject } from '@backstage/types';
+import { EnabledScheduleDefinition } from './src/config/types';
 
 export interface Config {
   renovate: {
@@ -30,12 +30,12 @@ export interface Config {
       /**
        * Schedule for the cleanup task
        */
-      cleanup: SchedulerServiceTaskScheduleDefinition;
+      cleanup?: EnabledScheduleDefinition;
 
       /**
        * Schedule when a renovation of all repositories should be triggered
        */
-      renovation: SchedulerServiceTaskScheduleDefinition;
+      renovation?: EnabledScheduleDefinition;
     };
 
     /**

package/dist/config/index.cjs.js

@@ -0,0 +1,43 @@
+'use strict';
+
+var backendPluginApi = require('@backstage/backend-plugin-api');
+
+const RENOVATE_ANNOTATION_KEEP_UPDATED = "renovate.secustor.dev/keep-updated";
+function getPluginConfig(rootConfig) {
+  return rootConfig.getConfig("renovate");
+}
+function getRenovateConfig(rootConfig) {
+  const value = getPluginConfig(rootConfig).getOptional("config");
+  return value ?? null;
+}
+function getRuntimeConfigs(rootConfig) {
+  const runtimeConfig = getPluginConfig(rootConfig).getConfig("runtime");
+  const runtime = runtimeConfig.getString("type");
+  return {
+    runtime,
+    config: runtimeConfig.getConfig(runtime)
+  };
+}
+function getScheduleDefinition(pluginConfig, variant) {
+  try {
+    const scheduleConfig = pluginConfig.getConfig(`schedules.${variant}`);
+    return {
+      enabled: scheduleConfig.getOptionalBoolean("enabled") ?? true,
+      ...backendPluginApi.readSchedulerServiceTaskScheduleDefinitionFromConfig(scheduleConfig)
+    };
+  } catch (e) {
+    return {
+      enabled: true,
+      scope: "global",
+      timeout: { minutes: 60 },
+      frequency: { minutes: 60 }
+    };
+  }
+}
+
+exports.RENOVATE_ANNOTATION_KEEP_UPDATED = RENOVATE_ANNOTATION_KEEP_UPDATED;
+exports.getPluginConfig = getPluginConfig;
+exports.getRenovateConfig = getRenovateConfig;
+exports.getRuntimeConfigs = getRuntimeConfigs;
+exports.getScheduleDefinition = getScheduleDefinition;
+//# sourceMappingURL=index.cjs.js.map

package/dist/config/index.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.cjs.js","sources":["../../src/config/index.ts"],"sourcesContent":["import { Config } from '@backstage/config';\nimport { readSchedulerServiceTaskScheduleDefinitionFromConfig } from '@backstage/backend-plugin-api';\nimport { JsonValue } from '@backstage/types';\n\nimport { EnabledScheduleDefinition } from './types';\n\nexport const RENOVATE_ANNOTATION_KEEP_UPDATED =\n  'renovate.secustor.dev/keep-updated';\n\nexport function getPluginConfig(rootConfig: Config): Config {\n  return rootConfig.getConfig('renovate');\n}\n\nexport function getRenovateConfig(rootConfig: Config): JsonValue {\n  const value = getPluginConfig(rootConfig).getOptional('config');\n  return value ?? null;\n}\n\nexport function getRuntimeConfigs(rootConfig: Config): {\n  runtime: string;\n  config: Config | null;\n} {\n  const runtimeConfig = getPluginConfig(rootConfig).getConfig('runtime');\n  const runtime = runtimeConfig.getString('type');\n  return {\n    runtime,\n    config: runtimeConfig.getConfig(runtime),\n  };\n}\n\nexport function getScheduleDefinition(\n  pluginConfig: Config,\n  variant: 'renovation' | 'cleanup',\n): EnabledScheduleDefinition {\n  try {\n    const scheduleConfig = pluginConfig.getConfig(`schedules.${variant}`);\n    return {\n      enabled: scheduleConfig.getOptionalBoolean('enabled') ?? true,\n      ...readSchedulerServiceTaskScheduleDefinitionFromConfig(scheduleConfig),\n    };\n  } catch (e) {\n    return {\n      enabled: true,\n      scope: 'global',\n      timeout: { minutes: 60 },\n      frequency: { minutes: 60 },\n    };\n  }\n}\n"],"names":["readSchedulerServiceTaskScheduleDefinitionFromConfig"],"mappings":";;;;AAMO,MAAM,gCACX,GAAA,qCAAA;AAEK,SAAS,gBAAgB,UAA4B,EAAA;AAC1D,EAAO,OAAA,UAAA,CAAW,UAAU,UAAU,CAAA,CAAA;AACxC,CAAA;AAEO,SAAS,kBAAkB,UAA+B,EAAA;AAC/D,EAAA,MAAM,KAAQ,GAAA,eAAA,CAAgB,UAAU,CAAA,CAAE,YAAY,QAAQ,CAAA,CAAA;AAC9D,EAAA,OAAO,KAAS,IAAA,IAAA,CAAA;AAClB,CAAA;AAEO,SAAS,kBAAkB,UAGhC,EAAA;AACA,EAAA,MAAM,aAAgB,GAAA,eAAA,CAAgB,UAAU,CAAA,CAAE,UAAU,SAAS,CAAA,CAAA;AACrE,EAAM,MAAA,OAAA,GAAU,aAAc,CAAA,SAAA,CAAU,MAAM,CAAA,CAAA;AAC9C,EAAO,OAAA;AAAA,IACL,OAAA;AAAA,IACA,MAAA,EAAQ,aAAc,CAAA,SAAA,CAAU,OAAO,CAAA;AAAA,GACzC,CAAA;AACF,CAAA;AAEgB,SAAA,qBAAA,CACd,cACA,OAC2B,EAAA;AAC3B,EAAI,IAAA;AACF,IAAA,MAAM,cAAiB,GAAA,YAAA,CAAa,SAAU,CAAA,CAAA,UAAA,EAAa,OAAO,CAAE,CAAA,CAAA,CAAA;AACpE,IAAO,OAAA;AAAA,MACL,OAAS,EAAA,cAAA,CAAe,kBAAmB,CAAA,SAAS,CAAK,IAAA,IAAA;AAAA,MACzD,GAAGA,sEAAqD,cAAc,CAAA;AAAA,KACxE,CAAA;AAAA,WACO,CAAG,EAAA;AACV,IAAO,OAAA;AAAA,MACL,OAAS,EAAA,IAAA;AAAA,MACT,KAAO,EAAA,QAAA;AAAA,MACP,OAAA,EAAS,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,MACvB,SAAA,EAAW,EAAE,OAAA,EAAS,EAAG,EAAA;AAAA,KAC3B,CAAA;AAAA,GACF;AACF;;;;;;;;"}