Skip to content

Commit

Permalink
doc: fix broken table in readme
Browse files Browse the repository at this point in the history 
There was a mis-aligned table for the config options in the readme.
This corrects the mistake
  • Loading branch information
@esatterwhite
esatterwhite committed Dec 19, 2022
1 parent d6f2def commit e85e6f3
Showing 1 changed file with 11 additions and 12 deletions.
23 changes: 11 additions & 12 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,7 @@ omitted, it is assumed the docker daemon is already authenticated with the targe
| `dockerArgs` | _Optional_. Include additional values for docker's `build-arg`. Supports templating | |
| `dockerPublish` | _Optional_. Automatically push image tags during the publish phase. | `true` |
| `dockerVerifyCmd` | _Optional_. If specified, during the verify stage, the specified command will execute in a container of the build image. If the command errors, the release will fail. | `false` |
| `dockerNetwork` | _Optional_. Specify the Docker network to use while the image is building. |
`default`
| `dockerNetwork` | _Optional_. Specify the Docker network to use while the image is building. | `default` |

### Build Arguments

Expand All @@ -65,16 +64,16 @@ build argument is explicitly `true`, the value will be omitted and the value fro
a matching environment variable will be utilized instead. This can be useful when trying to include
secrets and other sensitive information

| Argument Name | Description | Default |
|---------------------|--------------------------------------------------------------------------------------------|------------------------------|
| `SRC_DIRECTORY` | The of the directory the build was triggered from | The directory name of CWD |
| Argument Name | Description | Default |
|---------------------|-------------------------------------------------------------------------------------------|------------------------------|
| `SRC_DIRECTORY` | The of the directory the build was triggered from | The directory name of CWD |
| `TARGET_PATH` | Path relative to the execution root. Useful for Sharing a Single Docker file in monorepos | |
| `NPM_PACKAGE_NAME` | The `name` property extracted from `package.json` - if present | |
| `NPM_PACKAGE_SCOPE` | The parsed scope from the `name` property from `package.json` - sans `@` | |
| `CONFIG_NAME` | The configured name of the docker image. | The parsed package name |
| `CONFIG_PROJECT` | The configured docker repo project name | The package scope if present |
| `GIT_SHA` | The commit SHA of the current release | |
| `GIT_TAG` | The git tag of the current release | |
| `NPM_PACKAGE_NAME` | The `name` property extracted from `package.json` - if present | |
| `NPM_PACKAGE_SCOPE` | The parsed scope from the `name` property from `package.json` - sans `@` | |
| `CONFIG_NAME` | The configured name of the docker image. | The parsed package name |
| `CONFIG_PROJECT` | The configured docker repo project name | The package scope if present |
| `GIT_SHA` | The commit SHA of the current release | |
| `GIT_TAG` | The git tag of the current release | |

### Template Variables

Expand Down Expand Up @@ -210,7 +209,7 @@ the default docker image tags for the 1.0.0 release would be `1.0.0`, `1-latest`
}
```

the docker tags for version `1.2.3` will be `1.2.3`, `1.2-latest`, `1-latest` and `latest`
the docker tags for version `1.2.3` will be `1.2.3`, `1.2-latest`, `1-latest` and `latest`
the docker tags for version `2.3.4-beta.6` will be `2.3.4-beta.6`, `2.3-beta`, `2-beta` and `beta`

## Development
Expand Down

0 comments on commit e85e6f3

Please sign in to comment.