Merge pull request #6549 from backstage/orkohunter/techdocs-warning-add-link

This commit is contained in:
Himanshu Mishra
2021-07-20 15:15:27 +02:00
committed by GitHub
3 changed files with 9 additions and 2 deletions
@@ -0,0 +1,5 @@
---
'@backstage/techdocs-common': patch
---
Add link to https://backstage.io/docs/features/techdocs/configuration in the log warning message about updating techdocs.generate key.
@@ -132,7 +132,8 @@ describe('readGeneratorConfig', () => {
runIn: 'local',
});
expect(logger.warn).toHaveBeenCalledWith(
`The 'techdocs.generators.techdocs' configuration key is deprecated and will be removed in the future. Please use 'techdocs.generator' instead.`,
`The 'techdocs.generators.techdocs' configuration key is deprecated and will be removed in the future. Please use 'techdocs.generator' instead. ` +
`See here https://backstage.io/docs/features/techdocs/configuration`,
);
});
});
@@ -168,7 +168,8 @@ export function readGeneratorConfig(
if (legacyGeneratorType) {
logger.warn(
`The 'techdocs.generators.techdocs' configuration key is deprecated and will be removed in the future. Please use 'techdocs.generator' instead.`,
`The 'techdocs.generators.techdocs' configuration key is deprecated and will be removed in the future. Please use 'techdocs.generator' instead. ` +
`See here https://backstage.io/docs/features/techdocs/configuration`,
);
}