Skip to content

Commit 3ccbd86

Browse files
committed
Fix docker volume mapping for --start-dsomm
Improved Usage documentation
1 parent 70f1933 commit 3ccbd86

3 files changed

Lines changed: 12 additions & 9 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Contributions that improve the DSOMM model are welcome. Please edit the source f
1212

1313
### Testing
1414

15-
After making changes, generate a new `model.yaml` and use it in a local DSOMM application to verify there are no technical issues.
15+
After making changes, generate a new `model.yaml` and start a local DSOMM application to verify there are no technical issues. (See below.)
1616

1717

1818
## Usage
@@ -40,6 +40,8 @@ To start a local DSOMM instance on http://localhost:8080, run:
4040

4141
- `./generateDimensions.bash --start-dsomm`
4242

43+
This will down the latest DSOMM docker image and spin it up as a docker container.
44+
4345

4446
### Test referenced URLs
4547

yaml-generation/generateDimensions.bash

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
#!/bin/bash
22

33
# Usage:
4-
# ./generateDimensions.bash --install First time, install composer dependencies
5-
# ./generateDimensions.bash Generate model.yaml
6-
# ./generateDimensions.bash --test-urls Test URLs in implementations.yaml
4+
# ./generateDimensions.bash Generate model.yaml
5+
# ./generateDimensions.bash --test-urls Test URLs in implementations.yaml
6+
# ./generateDimensions.bash --start-dsomm Run local DSOMM with generated model.yaml
77

88
cd "$(dirname "$0")"/..
99

@@ -17,7 +17,8 @@ MSYS_NO_PATHCONV=1 $DOCKER_CMD run -ti --rm --volume "${PWD}:/app" wurstbrot/dso
1717

1818
if [ "$1" = "--start-dsomm" ]; then
1919
echo "Starting local DSOMM application..."
20-
MSYS_NO_PATHCONV=1 $DOCKER_CMD run -ti --rm --volume "${PWD}/generated/model.yaml:/generated/model.yaml" -p 8080:8080 wurstbrot/dsomm
20+
MSYS_NO_PATHCONV=1 $DOCKER_CMD run -ti --rm --volume "${PWD}/generated/model.yaml:/srv/assets/YAML/default/model.yaml" -p 8080:8080 wurstbrot/dsomm
21+
2122
elif [ "$1" = "--test-urls" ]; then
2223
echo "Test URLs in implementations.yaml..."
2324
MSYS_NO_PATHCONV=1 $DOCKER_CMD run -e TEST_REFERENCED_URLS=true -ti --rm --volume "${PWD}:/app" wurstbrot/dsomm-yaml-generation bash -c 'cd /app/ && php yaml-generation/generateDimensions.php' | tee url-test-results.txt

yaml-generation/generateDimensions.bat

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
@echo off
22

33
REM Usage:
4-
REM ./generateDimensions.bash --install First time, install composer dependencies
5-
REM ./generateDimensions.bash Generate model.yaml
6-
REM ./generateDimensions.bash --test-urls Test URLs in implementations.yaml
4+
REM ./generateDimensions.bash Generate model.yaml
5+
REM ./generateDimensions.bash --test-urls Test URLs in implementations.yaml
6+
REM ./generateDimensions.bash --start-dsomm Run local DSOMM with generated model.yaml
77

88
setlocal
99
REM Change working directory to the project root
@@ -19,7 +19,7 @@ echo Installing composer dependencies...
1919

2020
if "%~1"=="--start-dsomm" (
2121
echo Start local DSOMM application...
22-
%DOCKER_CMD% run -ti --rm --volume "%CD%/generated/model.yaml:/generated/model.yaml" -p 8080:8080 wurstbrot/dsomm
22+
%DOCKER_CMD% run -ti --rm --volume "%CD%/generated/model.yaml:/srv/assets/YAML/default/model.yaml" -p 8080:8080 wurstbrot/dsomm
2323

2424
) else if "%~1"=="--test-urls" (
2525
echo Test URLs in implementations.yaml...

0 commit comments

Comments
 (0)