tbd
- Docker
- Build image using
Dockerfile(e.g.docker_build.sh) - Run image with env variables and volumes described below, e.g.:
source env/spinner.envdocker_run.sh
Example usage in project's package.json:
"@closerplatform/spinner": "/Users/.../swagger/build",
| Name | Function | Example |
|---|---|---|
| YAML_FILE_PATH | Path to definitions file, depends on where the volume was mounted | /resources/closerAPI.yaml |
| PROJECT_NAME | Name of project, used when naming package.json | spinner |
| PROJECT_VERSION | Version of project, used in package.json | 1.0.0 |
| SHOULD_PUBLISH |
| Type | Example | Function |
|---|---|---|
| Required | -v $YAML_FILE_DIRECTORY:/resources:ro | make directory with definitions file accessible in container |
| Optional | -v $PWD/build:/swagger/build | link built output |
npmNamenpmVersionsupportsES6modelPropertyNaming