Merge pull request #16721 from Bonial-International-GmbH/pjungermann/uffizzi-techdocs

feat: add documented component to uffizzi environment

.github/uffizzi/docker-compose.uffizzi.yml

@@ -14,6 +14,7 @@ services:
       POSTGRES_PORT: 5432
       POSTGRES_USER: postgres
       POSTGRES_PASSWORD: kiTMoTsiEuyQ43GrL4Hv
+      REF_NAME: ${GITHUB_SHA}
       NODE_ENV: production
     deploy:
       resources:

.github/uffizzi/uffizzi.production.app-config.yaml

@@ -28,6 +28,7 @@ backend:
     credentials: true
   csp:
     connect-src: ["'self'", 'http:', 'https:']
+    img-src: ["'self'", 'data:', 'https://cdnjs.cloudflare.com']
     # Content-Security-Policy directives follow the Helmet format: https://helmetjs.github.io/#reference
     # Default Helmet Content-Security-Policy values can be removed by setting the key to false
 
@@ -41,15 +42,18 @@ auth:
 catalog:
   locations:
     - type: url
-      target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/all.yaml
+      target: https://github.com/backstage/backstage/blob/${REF_NAME}/packages/catalog-model/examples/all.yaml
 
     - type: url
-      target: https://github.com/backstage/backstage/blob/master/packages/catalog-model/examples/acme-corp.yaml
+      target: https://github.com/backstage/backstage/blob/${REF_NAME}/plugins/techdocs-backend/examples/documented-component-uffizzi/catalog-info.yaml
+
+    - type: url
+      target: https://github.com/backstage/backstage/blob/${REF_NAME}/packages/catalog-model/examples/acme-corp.yaml
       rules:
         - allow: [User, Group]
 
     - type: url
-      target: https://github.com/backstage/backstage/blob/master/plugins/scaffolder-backend/sample-templates/all-templates.yaml
+      target: https://github.com/backstage/backstage/blob/${REF_NAME}/plugins/scaffolder-backend/sample-templates/all-templates.yaml
       rules:
         - allow: [Template]
 
@@ -124,7 +128,7 @@ proxy:
 techdocs:
   builder: 'local' # Alternatives - 'external'
   generator:
-    runIn: 'docker'
+    runIn: 'local'
     # dockerImage: my-org/techdocs # use a custom docker image
     # pullImage: true # or false to disable automatic pulling of image (e.g. if custom docker login is required)
   publisher:

.github/workflows/uffizzi-build.yml

@@ -81,7 +81,7 @@ jobs:
           BACKSTAGE_IMAGE=$(echo ${{ needs.build-backstage.outputs.tags }})
           export BACKSTAGE_IMAGE
           # Render simple template from environment variables.
-          envsubst '$BACKSTAGE_IMAGE' < .github/uffizzi/docker-compose.uffizzi.yml > docker-compose.rendered.yml
+          envsubst '$BACKSTAGE_IMAGE $GITHUB_SHA' < .github/uffizzi/docker-compose.uffizzi.yml > docker-compose.rendered.yml
           cat docker-compose.rendered.yml
       - name: Upload Rendered Compose File as Artifact
         uses: actions/upload-artifact@v3