diff --git a/.changeset/polite-knives-lie.md b/.changeset/polite-knives-lie.md new file mode 100644 index 0000000000..7f1cad0544 --- /dev/null +++ b/.changeset/polite-knives-lie.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-tech-insights-backend': patch +--- + +Update README to match config options. diff --git a/plugins/tech-insights-backend/README.md b/plugins/tech-insights-backend/README.md index d78048ef68..80b21c2dd4 100644 --- a/plugins/tech-insights-backend/README.md +++ b/plugins/tech-insights-backend/README.md @@ -85,10 +85,10 @@ const myFactRetriever = { */ }; -const myFactRetrieverRegistration = createFactRetrieverRegistration( - '1 * 3 * * ', // On the first minute of the third day of the month - myFactRetriever, -); +const myFactRetrieverRegistration = createFactRetrieverRegistration({ + cadence: '1 * 2 * * ', // On the first minute of the second day of the month + factRetriever: myFactRetriever, +}); ``` FactRetrieverRegistration also accepts an optional `lifecycle` configuration value. This can be either MaxItems or TTL (time to live). Valid options for this value are either a number for MaxItems or a Luxon duration like object for TTL. For example: