From 08064544cdb7284e312a146c9e1a5b81b1d35335 Mon Sep 17 00:00:00 2001 From: Eric Satterwhite Date: Wed, 5 Aug 2020 11:40:20 -0500 Subject: [PATCH] doc(README): Fix a few typos 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 --- README.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index d336312..11f0551 100644 --- a/README.md +++ b/README.md @@ -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", @@ -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", @@ -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