chore(devtools): move DevTools to *.scion.vercel.app subdomain

We have moved the SCION Microfrontend Platform DevTools to the `*.scion.vercel.app` subdomain. The subdomain helps formulate a Content Security Policy (CSP) to allow embedding versioned DevTools into a CSP-protected site. BREAKING CHANGE: The URL of the SCION Microfrontend Platform DevTools has changed. The URL of previous releases has not changed. The current version (`1.3.1`) is available at the previous and new URL. New releases will be available only at the new URL. To migrate, load the DevTools from https://microfrontend-platform-devtools.scion.vercel.app (latest) or http://microfrontend-platform-devtools-vx-y-z.scion.vercel.app (versioned). Previously, DevTools were available at https://scion-microfrontend-platform-devtools.vercel.app and https://scion-microfrontend-platform-devtools-vx-y-x.vercel.app.
SchweizerischeBundesbahnen · Oct 30, 2024 · 3897efe · 3897efe
1 parent 4be61e3
commit 3897efe
Show file tree

Hide file tree

Showing 8 changed files with 19 additions and 19 deletions.
diff --git a/.github/workflows/manual-workflow.deploy-devtools.yml b/.github/workflows/manual-workflow.deploy-devtools.yml
@@ -107,5 +107,5 @@ jobs:
           project-id: ${{ secrets.VERCEL_MICROFRONTEND_PLATFORM_DEVTOOLS_PROJECT_ID }}
           version: ${{ needs.build-platform.outputs.version }}
           aliases: |
-            scion-microfrontend-platform-devtools.vercel.app,
-            scion-microfrontend-platform-devtools-v%v.vercel.app
+            microfrontend-platform-devtools.scion.vercel.app, 
+            microfrontend-platform-devtools-v%v.scion.vercel.app
diff --git a/.github/workflows/workflow.yml b/.github/workflows/workflow.yml
@@ -235,8 +235,8 @@ jobs:
           project-id: ${{ secrets.VERCEL_MICROFRONTEND_PLATFORM_DEVTOOLS_PROJECT_ID }}
           version: ${{ needs.build-platform.outputs.version }}
           aliases: |
-            scion-microfrontend-platform-devtools.vercel.app,
-            scion-microfrontend-platform-devtools-v%v.vercel.app
+            microfrontend-platform-devtools.scion.vercel.app, 
+            microfrontend-platform-devtools-v%v.scion.vercel.app
       - name: 'Publishing API Documentation (TypeDoc) to Vercel'
         uses: SchweizerischeBundesbahnen/scion-toolkit/.github/actions/vercel-deploy@master
         with:

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -285,8 +285,8 @@ This chapter describes the tasks to publish a new release to NPM.
       - https://scion-microfrontend-platform-testing-app3-vX-X-X.vercel.app.
       - https://scion-microfrontend-platform-testing-app4-vX-X-X.vercel.app.
    - Deploys DevTools to Vercel:
-      - https://scion-microfrontend-platform-devtools.vercel.app.
-      - https://scion-microfrontend-platform-devtools-vX-X-X.vercel.app.
+      - https://microfrontend-platform-devtools.scion.vercel.app.
+      - https://microfrontend-platform-devtools-vX-X-X.scion.vercel.app.
    - Publishes API Documentation (TypeDoc) to Vercel: 
       - https://scion-microfrontend-platform-api.vercel.app.
       - https://scion-microfrontend-platform-api-vX-X-X.vercel.app.

diff --git a/apps/microfrontend-platform-testing-app/src/environments/environment.vercel.ts b/apps/microfrontend-platform-testing-app/src/environments/environment.vercel.ts
@@ -14,7 +14,7 @@ import {ApplicationConfig} from '@scion/microfrontend-platform';
 const version = packageJson.version.replace(/\./g, '-');
 const devtools: ApplicationConfig | null = {
   symbolicName: 'devtools',
-  manifestUrl: `https://scion-microfrontend-platform-devtools-v${version}.vercel.app/manifest.json`,
+  manifestUrl: `https://microfrontend-platform-devtools-v${version}.scion.vercel.app/manifest.json`,
   intentionCheckDisabled: true,
   scopeCheckDisabled: true,
 };

diff --git a/...ontend-platform-developer-guide/chapters/miscellaneous/dev-tools/dev-tools.adoc b/...ontend-platform-developer-guide/chapters/miscellaneous/dev-tools/dev-tools.adoc
@@ -13,13 +13,13 @@ The SCION DevTools is a microfrontend that allows inspecting installed micro app
 include::dev-tools.snippets.ts[tags=dev-tools:register-dev-tools]
 ----
 
-IMPORTANT: Note that we need to disable some checks for the SCION DevTools to have access to private capabilities. We strongly recommend not to do this for regular micro applications.
+IMPORTANT: Note that we need to disable some checks for the SCION DevTools to have access to private capabilities. We recommend not to do this for regular micro applications.
 
 [NOTE]
 ====
-With each release of the SCION Microfrontend Platform, we also publish a new version of the SCION DevTools. We strongly recommend integrating the SCION DevTools via the versioned URL to be compatible with your platform version.
+With each release of the SCION Microfrontend Platform, we also publish a new version of the SCION DevTools. We recommend integrating the SCION DevTools via the versioned URL to be compatible with your platform version.
 
-Example: https://scion-microfrontend-platform-devtools-v{revnumber-dasherized}.vercel.app/manifest.json
+Example: https://microfrontend-platform-devtools-v{revnumber-dasherized}.scion.vercel.app/manifest.json
 ====
 
 .2. Create a router outlet to display the SCION DevTools

diff --git a/...ofrontend-platform-developer-guide/chapters/miscellaneous/dev-tools/dev-tools.snippets.ts b/...ofrontend-platform-developer-guide/chapters/miscellaneous/dev-tools/dev-tools.snippets.ts
@@ -10,7 +10,7 @@ import {Beans} from '@scion/toolkit/bean-manager';
       // register the 'devtools' micro application
       {
         symbolicName: 'devtools',
-        manifestUrl: 'https://scion-microfrontend-platform-devtools-<version>.vercel.app/manifest.json',
+        manifestUrl: 'https://microfrontend-platform-devtools-<version>.scion.vercel.app/manifest.json',
         intentionCheckDisabled: true,
         scopeCheckDisabled: true,
       },
@@ -27,7 +27,7 @@ import {Beans} from '@scion/toolkit/bean-manager';
 
 {
   // tag::dev-tools:integrate-via-url[]
-  Beans.get(OutletRouter).navigate('https://scion-microfrontend-platform-devtools-<version>.vercel.app', {outlet: 'devtools'});
+  Beans.get(OutletRouter).navigate('https://microfrontend-platform-devtools-<version>.scion.vercel.app', {outlet: 'devtools'});
   // end::dev-tools:integrate-via-url[]
 }
 

diff --git a/docs/site/getting-started/07-getting-started-devtools.md b/docs/site/getting-started/07-getting-started-devtools.md
@@ -26,7 +26,7 @@ Follow the steps below to register the *SCION DevTools* micro app.
                {symbolicName: 'customers-app', manifestUrl: 'http://localhost:4202/manifest.json'},
    [+]         {
    [+]           symbolicName: 'devtools',
-   [+]           manifestUrl: 'https://scion-microfrontend-platform-devtools.vercel.app/manifest.json',
+   [+]           manifestUrl: 'https://microfrontend-platform-devtools.scion.vercel.app/manifest.json',
    [+]           intentionCheckDisabled: true,
    [+]           scopeCheckDisabled: true,
    [+]         },
@@ -63,7 +63,7 @@ Like any other micro app, the host app must declare its intentions in its manife
                {symbolicName: 'customers-app', manifestUrl: 'http://localhost:4202/manifest.json'},
                {
                  symbolicName: 'devtools',
-                 manifestUrl: 'https://scion-microfrontend-platform-devtools.vercel.app/manifest.json',
+                 manifestUrl: 'https://microfrontend-platform-devtools.scion.vercel.app/manifest.json',
                  intentionCheckDisabled: true,
                  scopeCheckDisabled: true,
                },
@@ -105,7 +105,7 @@ In the [first chapter][link-getting-started:01:host-app] we added a router outle
                {symbolicName: 'customers-app', manifestUrl: 'http://localhost:4202/manifest.json'},
                {
                  symbolicName: 'devtools',
-                 manifestUrl: 'https://scion-microfrontend-platform-devtools.vercel.app/manifest.json',
+                 manifestUrl: 'https://microfrontend-platform-devtools.scion.vercel.app/manifest.json',
                  intentionCheckDisabled: true,
                  scopeCheckDisabled: true,
                },
@@ -167,7 +167,7 @@ class HostController {
         {symbolicName: 'customers-app', manifestUrl: 'http://localhost:4202/manifest.json'},
         {
           symbolicName: 'devtools',
-          manifestUrl: 'https://scion-microfrontend-platform-devtools.vercel.app/manifest.json',
+          manifestUrl: 'https://microfrontend-platform-devtools.scion.vercel.app/manifest.json',
           intentionCheckDisabled: true,
           scopeCheckDisabled: true,
         },

diff --git a/docs/site/getting-started/08-getting-started-browse-capabilities.md b/docs/site/getting-started/08-getting-started-browse-capabilities.md
@@ -120,7 +120,7 @@ In order for the host app to browse and navigate to microfrontend capabilities,
             {symbolicName: 'customers-app', manifestUrl: 'http://localhost:4202/manifest.json'},
             {
               symbolicName: 'devtools',
-              manifestUrl: 'https://scion-microfrontend-platform-devtools.vercel.app/manifest.json',
+              manifestUrl: 'https://microfrontend-platform-devtools.scion.vercel.app/manifest.json',
               intentionCheckDisabled: true,
               scopeCheckDisabled: true,
             },
@@ -177,7 +177,7 @@ In order for the host app to browse and navigate to microfrontend capabilities,
               {symbolicName: 'customers-app', manifestUrl: 'http://localhost:4202/manifest.json'},
               {
                 symbolicName: 'devtools',
-                manifestUrl: 'https://scion-microfrontend-platform-devtools.vercel.app/manifest.json',
+                manifestUrl: 'https://microfrontend-platform-devtools.scion.vercel.app/manifest.json',
                 intentionCheckDisabled: true,
                 scopeCheckDisabled: true,
               },
@@ -363,7 +363,7 @@ class HostController {
         {symbolicName: 'customers-app', manifestUrl: 'http://localhost:4202/manifest.json'},
         {
           symbolicName: 'devtools',
-          manifestUrl: 'https://scion-microfrontend-platform-devtools.vercel.app/manifest.json',
+          manifestUrl: 'https://microfrontend-platform-devtools.scion.vercel.app/manifest.json',
           intentionCheckDisabled: true,
           scopeCheckDisabled: true,
         },