From 96ccc8f6946ca8e2edb3e8baec5fc86eb73dfd3b Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Sat, 27 Feb 2021 15:21:49 +0100 Subject: [PATCH] scaffolder-backend: remove support for deprecated publisher configuration --- .changeset/spotty-cooks-work.md | 22 +++++++ .../scaffolder/stages/publish/publishers.ts | 65 +------------------ 2 files changed, 23 insertions(+), 64 deletions(-) create mode 100644 .changeset/spotty-cooks-work.md diff --git a/.changeset/spotty-cooks-work.md b/.changeset/spotty-cooks-work.md new file mode 100644 index 0000000000..d8845918bf --- /dev/null +++ b/.changeset/spotty-cooks-work.md @@ -0,0 +1,22 @@ +--- +'@backstage/plugin-scaffolder-backend': minor +--- + +Removed support for deprecated publisher auth configuration within the `scaffolder` configuration block, such as `scaffolder.github.token`. Access should instead be configured through `integrations` configuration. + +For example, replace the following configuration in `app-config.yaml` + +```yaml +scaffolder: + github: + token: my-token +``` + +with + +```yaml +integrations: + github: + - host: github.com + token: my-token +``` diff --git a/plugins/scaffolder-backend/src/scaffolder/stages/publish/publishers.ts b/plugins/scaffolder-backend/src/scaffolder/stages/publish/publishers.ts index f5f7fc6361..7f4fa6b450 100644 --- a/plugins/scaffolder-backend/src/scaffolder/stages/publish/publishers.ts +++ b/plugins/scaffolder-backend/src/scaffolder/stages/publish/publishers.ts @@ -51,32 +51,16 @@ export class Publishers implements PublisherBuilder { static async fromConfig( config: Config, - { logger }: { logger: Logger }, + _options: { logger: Logger }, ): Promise { const publishers = new Publishers(); const scm = ScmIntegrations.fromConfig(config); - const deprecationWarning = (name: string) => { - logger.warn( - `'Specifying credentials for ${name} in the Scaffolder configuration is deprecated. This will cause errors in a future release. Please migrate to using integrations config and specifying tokens under hostnames'`, - ); - }; - for (const integration of scm.azure.list()) { const publisher = await AzurePublisher.fromConfig(integration.config); if (publisher) { publishers.register(integration.config.host, publisher); - } else { - deprecationWarning('Azure'); - - publishers.register( - integration.config.host, - await AzurePublisher.fromConfig({ - token: config.getOptionalString('scaffolder.azure.token'), - host: integration.config.host, - }), - ); } } @@ -90,19 +74,6 @@ export class Publishers implements PublisherBuilder { }); if (publisher) { publishers.register(integration.config.host, publisher); - } else { - deprecationWarning('GitHub'); - - publishers.register( - integration.config.host, - await GithubPublisher.fromConfig( - { - token: config.getOptionalString('scaffolder.github.token') ?? '', - host: integration.config.host, - }, - { repoVisibility }, - ), - ); } } @@ -117,21 +88,6 @@ export class Publishers implements PublisherBuilder { if (publisher) { publishers.register(integration.config.host, publisher); - } else { - deprecationWarning('Gitlab'); - - publishers.register( - integration.config.host, - await GitlabPublisher.fromConfig( - { - token: config.getOptionalString('scaffolder.gitlab.token') ?? '', - host: integration.config.host, - apiBaseUrl: ``, - baseUrl: `https://${integration.config.host}`, - }, - { repoVisibility }, - ), - ); } } @@ -149,25 +105,6 @@ export class Publishers implements PublisherBuilder { if (publisher) { publishers.register(integration.config.host, publisher); - } else { - deprecationWarning('Bitbucket'); - - publishers.register( - integration.config.host, - await BitbucketPublisher.fromConfig( - { - token: - config.getOptionalString('scaffolder.bitbucket.token') ?? '', - username: - config.getOptionalString('scaffolder.bitbucket.username') ?? '', - appPassword: - config.getOptionalString('scaffolder.bitbucket.appPassword') ?? - '', - host: integration.config.host, - }, - { repoVisibility }, - ), - ); } }