Skip to content

Commit 78766d9

Browse files
author
Sean Sundberg
authored
Updates readme (#16)
Signed-off-by: Sean Sundberg <seansund@us.ibm.com>
1 parent 286a0e7 commit 78766d9

1 file changed

Lines changed: 0 additions & 54 deletions

File tree

README.md

Lines changed: 0 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -152,57 +152,3 @@ npm start
152152
- `scripts/` - directory for shell scripts used by `package.json` scripts to build, test, and
153153
push the image
154154
- `src/` - directory containing files that should be included in the built image
155-
156-
### Commands
157-
158-
The following commands should be used when developing the docker image. They use scripts
159-
provided in the `scripts/` folder.
160-
161-
#### Build the image
162-
163-
```bash
164-
npm run build
165-
```
166-
167-
This will build the image locally with the tag `IMAGE_NAME`:`IMAGE_VERSION`.
168-
169-
#### Test the image
170-
171-
```bash
172-
npm test
173-
```
174-
175-
This will build the image locally, if necessary, and validate the elements of the
176-
image.
177-
178-
The tests use Google's `container-structure-test` to validate the structure of
179-
the image. Configuration for these tests are provided in the aptly named `config.yaml`.
180-
181-
See https://github.com/GoogleContainerTools/container-structure-test for information on the
182-
defined values for the test definition.
183-
184-
#### Push the image to Docker Hub
185-
186-
```bash
187-
npm run push
188-
```
189-
190-
This will tag the local image version with the `IMAGE_ORG`/`IMAGE_NAME`:`IMAGE_VERSION`
191-
tag and push it to Docker Hub.
192-
193-
#### Configuration
194-
195-
These scripts require parameters for:
196-
- `IMAGE_ORG`
197-
- `IMAGE_NAME`
198-
- `IMAGE_VERSION`
199-
200-
When the scripts are run using `npm` (recommended) then these parameters are provided from
201-
config values in `package.json`:
202-
- `org`
203-
- `name`
204-
- `version`
205-
206-
The default/preferred `org` for the image is `garagecatalyst`. If you need access to the
207-
org in Docker Hub contact Matt Perrins (mjperrin@us.ibm.com) or Sean Sundberg
208-
(seansund@us.ibm.com).

0 commit comments

Comments
 (0)