Skip to content
This repository was archived by the owner on Nov 18, 2020. It is now read-only.

Commit 64fac07

Browse files
committed
cleanup the e2e help text and help target
1 parent 8236e01 commit 64fac07

File tree

2 files changed

+18
-13
lines changed

2 files changed

+18
-13
lines changed

memcached-operator/Makefile

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,8 +55,8 @@ code-gen: ## Run the operator-sdk commands to generated code (k8s and openapi)
5555

5656
##@ Tests
5757

58-
test-e2e: ## Run integration tests. This command will execute many times the same e2e tests. Its purposes is just to illustrate few options. For further info see: https://github.com/operator-framework/operator-sdk/blob/master/doc/test-framework/writing-e2e-tests.md
59-
@echo ... Running the same e2e tests with some few options of args ...
58+
test-e2e: ## Run integration e2e tests with different options. See: https://github.com/operator-framework/operator-sdk/blob/master/doc/test-framework/writing-e2e-tests.md
59+
@echo ... Running the same e2e tests with different args ...
6060
@echo ... Running locally ...
6161
- operator-sdk test local ./test/e2e --up-local --namespace=${NAMESPACE}
6262
@echo ... Running NOT in parallel ...
@@ -71,5 +71,8 @@ test-e2e: ## Run integration tests. This command will execute many times the sam
7171
- operator-sdk test local ./test/e2e --verbose
7272

7373
.PHONY: help
74-
help: ## Display this help
75-
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
74+
help: ## Display this help
75+
@echo -e "Usage:\n make \033[36m<target>\033[0m"
76+
@awk 'BEGIN {FS = ":.*##"}; \
77+
/^[a-zA-Z0-9_-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } \
78+
/^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)

memcached-operator/README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -52,23 +52,25 @@ $ sed -i 's|REPLACE_IMAGE|quay.io/example-inc/memcached-operator|g' deploy/opera
5252
$ sed -i "" 's|REPLACE_IMAGE|quay.io/example-inc/memcached-operator|g' deploy/operator.yaml
5353
```
5454

55-
**NOTE** The `quay.io/example-inc/memcached-operator` is an example. You should build and push the image for your repository.
55+
**NOTE** The `quay.io/example-inc/memcached-operator` is an example. You should build and push the image for your repository.
5656

5757
### Installing
5858

5959
Run `make install` to install the operator. Check that the operator is running in the cluster, also check that the example Memcached service was deployed.
6060

61-
### Uninstalling
61+
### Uninstalling
6262

6363
To uninstall all that was performed in the above step run `make uninstall`.
6464

65-
[dep_tool]:https://golang.github.io/dep/docs/installation.html
66-
[go_tool]:https://golang.org/dl/
67-
[kubectl_tool]:https://kubernetes.io/docs/tasks/tools/install-kubectl/
68-
[docker_tool]:https://docs.docker.com/install/
69-
[operator_sdk]:https://github.com/operator-framework/operator-sdk
70-
[operator_install]:https://github.com/operator-framework/operator-sdk/blob/master/doc/user/install-operator-sdk.md
65+
[dep_tool](https://golang.github.io/dep/docs/installation.html)
66+
[go_tool](https://golang.org/dl/)
67+
[kubectl_tool](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
68+
[docker_tool](https://docs.docker.com/install/)
69+
[operator_sdk](https://github.com/operator-framework/operator-sdk)
70+
[operator_install](https://github.com/operator-framework/operator-sdk/blob/master/doc/user/install-operator-sdk.md)
7171

7272
### Run Tests
7373

74-
Run `make test-e2e` to run integration tests. This command will execute many times the same e2e tests. Its purposes is just to illustrate few options.
74+
Run `make test-e2e` to run the integration e2e tests with different options. For
75+
more information see the [writing e2e tests](https://github.com/operator-framework/operator-sdk/blob/master/doc/test-framework/writing-e2e-tests.md) guide.
76+

0 commit comments

Comments
 (0)