Skip to content

Commit

Permalink
doc(README): Fix a few typos
Browse files Browse the repository at this point in the history
This fixes a typo in a config key and removes an unused param `path`.
Cleans up the docker tag examples to be a little more realistic

Semver: minor
  • Loading branch information
esatterwhite committed Aug 5, 2020
1 parent a5c11fc commit 0806454
Showing 1 changed file with 5 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,7 @@ full configuration:
"plugins": [
["@codedependant/semantic-release-docker", {
"docker": {
"path": "@codedependant/semantic-release-docker",
"tags": ["{version}", "{major}", "{major}.{minor}"],
"tags": ["latest", "{version}", "{major}-latest", "{major}.{minor}"],
"image": "my-image",
"dockerfile": "Dockerfile",
"registry": "quay.io",
Expand All @@ -74,16 +73,15 @@ full configuration:
}
```

results in `quay.io/codedependant/my-image` with tags `1.0.0`, `1` and the `1.0` determined by `semantic-release`.
results in `quay.io/codedependant/my-image` with tags `latest`, `1.0.0`, `1-latest` and the `1.0` determined by `semantic-release`.

Alternatively, using global options w/ root configuration
```json
{
"release": {
"extendds": "@internal/release-config-example",
"extends": "@internal/release-config-example",
"docker": {
"path": "@codedependant/semantic-release-docker",
"tags": ["{version}", "{major}", "{major}.{minor}"],
"tags": ["latest", "{version}", "{major}-latest", "{major}.{minor}"],
"image": "my-image",
"dockerfile": "Dockerfile",
"registry": "quay.io",
Expand All @@ -108,7 +106,7 @@ minimum configuration:
* A package name `@codedependant/test-project` results in `codedependant/test-project`
* A package name `test-project` results in `test-project`

the default tags @1.0.0 would be `1.0.0`, `1-latest`, `latest`
the default docker image tags for the 1.0.0 release would be `1.0.0`, `1-latest`, `latest`

## Development

Expand Down

0 comments on commit 0806454

Please sign in to comment.