From bf9b31e6f7420c4d2bc3621021503a8f5a80db03 Mon Sep 17 00:00:00 2001 From: Christopher Crone <christopher.crone@docker.com> Date: Thu, 16 Jul 2020 13:21:08 +0200 Subject: [PATCH] readme: Fix typos Signed-off-by: Christopher Crone <christopher.crone@docker.com> --- README.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index e083cb843..ef941d06c 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ If you don't have or want to use Docker for building you need to make sure you h And then you can call the same make targets but you need to pass it the `builder.Makefile` (`make -f builder.Makefile`). -The new CLI delegates to the classic docker for default contexts ; delegation is done to `com.docker.cli`. +The new CLI delegates to the classic docker for default contexts ; delegation is done to `com.docker.cli`. * `make moby-cli-link` will create a `com.docker.cli` link in `/usr/local/bin` if you don't already have it from Docker Desktop ## Building the project @@ -33,7 +33,7 @@ If you make changes to the `.proto` files, make sure to `make protos` to generat ## Tests -### unit tests +### Unit tests ``` make test @@ -44,34 +44,34 @@ If you need to update a golden file simply do `go test ./... -test.update-golden ### e2e tests ``` -make e2e_local +make e2e-local ``` -This requires a local docker engine running +This requires a local Docker Engine running ``` -AZURE_TENANT_ID="xxx" AZURE_CLIENT_ID="yyy" AZURE_CLIENT_SECRET="yyy" make e2e_aci +AZURE_TENANT_ID="xxx" AZURE_CLIENT_ID="yyy" AZURE_CLIENT_SECRET="yyy" make e2e-aci ``` -This requires azure service principal credentials to login to azure. -To get the values to be set in local environment variables, you can create a new service principal once you're logged in azure (with `docker login azure`) +This requires azure service principal credentials to login to azure. +To get the values to be set in local environment variables, you can create a new service principal once you're logged in azure (with `docker login azure`) ``` az ad sp create-for-rbac --name 'MyTestServicePrincipal' --sdk-auth ``` -Running aci e2e tests will override your local login, the service principal credentials use a token that cannot be refreshed automatically. +Running the ACI e2e tests will override your local login, the service principal credentials use a token that cannot be refreshed automatically. You might need to run again `docker login azure` to properly use the command line after running ACI e2e tests. -You can also run a single ACI test from the test suite : +You can also run a single ACI test from the test suite: ``` TESTIFY=TestACIRunSingleContainer AZURE_TENANT_ID="xxx" AZURE_CLIENT_ID="yyy" AZURE_CLIENT_SECRET="yyy" make e2e-aci ``` ## Release -To create a new release: -* check that the CI is green on the master commit you want to release -* simply create a new tag of th form vx.y.z, following existing tags, and push the tag +To create a new release: +* check that the CI is green on the master commit you want to release +* simply create a new tag of the form vx.y.z, following existing tags, and push the tag -Pushing the tag will automatically ceate a new release and make binaries (mac, win, linux) available for download. +Pushing the tag will automatically create a new release and make binaries (mac, win, linux) available for download. -Note: Linux binaries are not automatically copied to /docker/aci-integration-beta, if you want to make the linux binary publically available, you'll need to manually create a release in aci-integration-beta and upload the binary. +Note: Linux binaries are not automatically copied to /docker/aci-integration-beta, if you want to make the linux binary publically available, you'll need to manually create a release in aci-integration-beta and upload the binary. For Desktop integration, you need to make a PR in /docker/pinata and update the cli release number [here](https://github.com/docker/pinata/blob/master/build.json#L25)