Merge pull request #56 from devsecopsmaturitymodel/feat/meta-on-top

feat: Releasing v4 of DSOMM app

Author: wurstbrot

.github/workflows/main.yml

@@ -53,12 +53,16 @@ jobs:
           file: Dockerfile
           platforms: linux/amd64,linux/arm64
           tags: wurstbrot/dsomm-yaml-generation:${{ steps.get-version.outputs.version }},wurstbrot/dsomm-yaml-generation:latest
-      - name: Extract generated.yaml
+      - name: Extract generated files from docker image
         run: |
           docker run -d --name=yaml --entrypoint="/bin/sleep" wurstbrot/dsomm-yaml-generation:${{ steps.get-version.outputs.version }} 60 
-          docker cp yaml:/var/www/html/src/assets/YAML/generated/generated.yaml src/assets/YAML/generated/generated.yaml
-      # Commit all changed files back to the repository
-      - uses: planetscale/ghcommit-action@v0.1.6
+          docker cp yaml:/var/www/html/generated/model.yaml generated/model.yaml 
+          docker cp yaml:/var/www/html/generated/dependency-tree.md generated/dependency-tree.md           
+      - name: Replace version placeholder in model.yaml
+        run: |
+          sed -i "s/__VERSION_PLACEHOLDER__/${{ steps.get-version.outputs.version }}/g" src/assets/YAML/model.yaml
+      - name: Commit all changed files back to the repository
+        uses: planetscale/ghcommit-action@v0.1.6
         with:
           commit_message: "🤖 fmt"
           repo: ${{ github.repository }}

.gitignore

@@ -43,5 +43,10 @@ testem.log
 .DS_Store  
 Thumbs.db 
 /yaml-generation/vendor/
-# Generated YAML
+
+
+# Generated
 /src/assets/YAML/generated/generated.yaml
+/generated/model.yaml
+/generated/dependency-tree.md
+url-test-results.txt

Dockerfile

@@ -10,8 +10,6 @@ RUN cd /var/www/html/yaml-generation && composer install \
 --prefer-dist
 
 RUN pecl channel-update pecl.php.net && pecl install yaml && docker-php-ext-enable yaml
-RUN curl https://raw.githubusercontent.com/devsecopsmaturitymodel/DevSecOps-MaturityModel/refs/heads/main/src/assets/YAML/meta.yaml -o /var/www/html/src/assets/YAML/meta.yaml
-RUN echo "test" ; cat /var/www/html/src/assets/YAML/meta.yaml 
 RUN cd /var/www/html && php yaml-generation/generateDimensions.php
 workdir /var/www/html
 CMD php yaml-generation/generateDimensions.php

README.md

@@ -1,6 +1,6 @@
 # OWASP DevSecOps Maturity Model Data
 
-This GitHub project ([DevSecOps-MaturityModel-data](https://github.com/devsecopsmaturitymodel/DevSecOps-MaturityModel-data)) contains the source for the model itself, used by the DSOMM applciation [DevSecOps-MaturityModel](https://github.com/devsecopsmaturitymodel/DevSecOps-MaturityModel). 
+This GitHub project ([DevSecOps-MaturityModel-data](https://github.com/devsecopsmaturitymodel/DevSecOps-MaturityModel-data)) contains the source for the DSOMM *model*. The model is used by the DSOMM applciation [DevSecOps-MaturityModel](https://github.com/devsecopsmaturitymodel/DevSecOps-MaturityModel). 
 
 The source files include dimensions, activities, descriptions, measures, and other model data used by the application.
 
@@ -12,7 +12,7 @@ Contributions that improve the DSOMM model are welcome. Please edit the source f
 
 ### Testing
 
-After making changes, generate a new `activities.yaml` and use it in a local DSOMM application to verify there are no technical issues.
+After making changes, generate a new `model.yaml` and start a local DSOMM application to verify there are no technical issues. (See below.)
 
 
 ## Usage
@@ -28,11 +28,7 @@ Depending on your platform use either `generateDimensions.bash` (Linux) or `gene
 
    `cd yaml-generation`
 
-3. Install dependencies:
-
-   `./generateDimensions.bash --install`
-
-4. Generate `activities.yaml`:
+3. Generate `model.yaml`:
 
    `./generateDimensions.bash`
 
@@ -42,14 +38,16 @@ Depending on your platform use either `generateDimensions.bash` (Linux) or `gene
 
 To start a local DSOMM instance on http://localhost:8080, run:
 
-   `./generateDimensions.bash --start-dsomm`
+  - `./generateDimensions.bash --start-dsomm`
+
+  This will down the latest DSOMM docker image and spin it up as a docker container.
 
 
 ### Test referenced URLs
 
 To test all URLs referenced by `implementations.yaml` and save results to `url-test-results.txt`, run:
 
-   `./generateDimensions.bash --test-urls`
+  - `./generateDimensions.bash --test-urls`
 
 
 ### Using Podman instead of Docker

generated/README.md

@@ -0,0 +1 @@
+GitHub Actions will update these generated files.