From df21bbd4ad56f413ab0190128b613997e9e50b76 Mon Sep 17 00:00:00 2001 From: Elizabeth Hobbs Date: Thu, 3 Nov 2022 14:02:15 -0700 Subject: [PATCH] Remove app.googleAnalyticsTrackingId and related scripts The analytics plugin removed the need for app.googleAnalyticsTrackingId and the script tags in packages/app/public/index.html. More context: https://discord.com/channels/687207715902193673/1007303347914690610/1014108244664401952 Signed-off-by: Elizabeth Hobbs --- .changeset/four-snails-raise.md | 5 +++ .changeset/lucky-falcons-dress.md | 38 +++++++++++++++++++ app-config.yaml | 1 - .../templates/backstage-app-config.yaml | 1 - contrib/chart/backstage/values.yaml | 1 - packages/app/public/index.html | 19 +--------- packages/cli/package.json | 8 ---- .../packages/app/public/index.html | 18 --------- plugins/config-schema/dev/example-schema.json | 6 --- 9 files changed, 44 insertions(+), 53 deletions(-) create mode 100644 .changeset/four-snails-raise.md create mode 100644 .changeset/lucky-falcons-dress.md diff --git a/.changeset/four-snails-raise.md b/.changeset/four-snails-raise.md new file mode 100644 index 0000000000..1484a454e1 --- /dev/null +++ b/.changeset/four-snails-raise.md @@ -0,0 +1,5 @@ +--- +'@backstage/cli': patch +--- + +Removed googleAnalyticsTrackingId configSchema. diff --git a/.changeset/lucky-falcons-dress.md b/.changeset/lucky-falcons-dress.md new file mode 100644 index 0000000000..16e5c8a015 --- /dev/null +++ b/.changeset/lucky-falcons-dress.md @@ -0,0 +1,38 @@ +--- +'@backstage/create-app': patch +--- + +The [Analytics API](https://backstage.io/docs/plugins/analytics) is the recommended way to track usage in Backstage; an optionally installable [Google Analytics module](https://github.com/backstage/backstage/tree/master/plugins/analytics-module-ga#installation) has superseded the old app.googleAnalyticsTrackingId config and its corresponding script tags in packages/app/public/index.html. + +For an existing installation where you want to remove the redundant app.googleAnalyticsTrackingId, you should make the following adjustment to `packages/app/public/index.html`: + +```diff + <%= config.getString('app.title') %> +- <% if (config.has('app.googleAnalyticsTrackingId')) { %> +- +- +- <% } %> + +``` + +Additionally, you should make the following adjustment to `app-config.yaml`: + +```diff +app: + title: Backstage Example App + baseUrl: http://localhost:3000 +- googleAnalyticsTrackingId: # UA-000000-0 +``` diff --git a/app-config.yaml b/app-config.yaml index 69a1207365..ef133491af 100644 --- a/app-config.yaml +++ b/app-config.yaml @@ -1,7 +1,6 @@ app: title: Backstage Example App baseUrl: http://localhost:3000 - googleAnalyticsTrackingId: # UA-000000-0 #datadogRum: # clientToken: '123456789' # applicationId: qwerty diff --git a/contrib/chart/backstage/templates/backstage-app-config.yaml b/contrib/chart/backstage/templates/backstage-app-config.yaml index f06e47feab..061fc3285b 100644 --- a/contrib/chart/backstage/templates/backstage-app-config.yaml +++ b/contrib/chart/backstage/templates/backstage-app-config.yaml @@ -13,7 +13,6 @@ metadata: data: APP_CONFIG_app_baseUrl: {{ .Values.appConfig.app.baseUrl | quote | quote }} APP_CONFIG_app_title: {{ .Values.appConfig.app.title | quote | quote }} - APP_CONFIG_app_googleAnalyticsTrackingId: {{ .Values.appConfig.app.googleAnalyticsTrackingId | quote | quote }} APP_CONFIG_backend_baseUrl: {{ .Values.appConfig.backend.baseUrl | quote | quote }} APP_CONFIG_backend_cors_origin: {{ .Values.appConfig.backend.cors.origin | quote | quote }} APP_CONFIG_techdocs_storageUrl: {{ .Values.appConfig.techdocs.storageUrl | quote | quote }} diff --git a/contrib/chart/backstage/values.yaml b/contrib/chart/backstage/values.yaml index 6ffe076e57..cd80fd954b 100644 --- a/contrib/chart/backstage/values.yaml +++ b/contrib/chart/backstage/values.yaml @@ -92,7 +92,6 @@ appConfig: app: baseUrl: https://demo.example.com title: Backstage - googleAnalyticsTrackingId: backend: baseUrl: https://demo.example.com listen: diff --git a/packages/app/public/index.html b/packages/app/public/index.html index 885fb6c228..863566e776 100644 --- a/packages/app/public/index.html +++ b/packages/app/public/index.html @@ -44,24 +44,7 @@ /> <%= config.getString('app.title') %> - <% if (config.has('app.googleAnalyticsTrackingId')) { %> - - - <% } %> <% if (config.has('app.datadogRum')) { %> + <% if (config.has('app.datadogRum')) { %> - - <% } %> diff --git a/plugins/config-schema/dev/example-schema.json b/plugins/config-schema/dev/example-schema.json index bb90595340..9c16e8c316 100644 --- a/plugins/config-schema/dev/example-schema.json +++ b/plugins/config-schema/dev/example-schema.json @@ -19,12 +19,6 @@ "visibility": "frontend", "description": "The title of the app." }, - "googleAnalyticsTrackingId": { - "type": "string", - "visibility": "frontend", - "description": "Tracking ID for Google Analytics", - "examples": ["UA-000000-0"] - }, "listen": { "type": "object", "description": "Listening configuration for local development",