Skip to content

Commit

Permalink
chore: readme cleanup & more info on e2e
Browse files Browse the repository at this point in the history
Signed-off-by: Bruno Bressi <[email protected]>
  • Loading branch information
puffitos committed Feb 3, 2024
1 parent 71a3819 commit 2e30275
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
6 changes: 0 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,6 @@ test-e2e:
@echo "Running e2e tests..."
@go test -v -race -count 1 ./test/

test-cleanup:
@echo "Cleaning up..."
@helm uninstall cosignwebhook -n cosignwebhook
@k3d registry delete k3d-registry.localhost
@k3d cluster delete cosign-tests

.PHONY: test-unit
test-unit:
@echo "Running unit tests..."
Expand Down
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ type: Opaque
The name of the secret must be `cosignwebhook` and the key `COSIGNPUBKEY`. The value of `COSIGNPUBKEY` must match the
public key used to sign the image you're deploying.

##
##

## Test

Expand Down Expand Up @@ -163,7 +163,9 @@ To run the E2E tests, the following steps are required (in order):
* the image is pushed to a local registry & deployed to the test cluster (`make e2e-deploy`)

To do all of the above, simply run `make e2e-prep`. Each step should also be able to be executed individually. To clean
up the E2E setup, run `make e2e-cleanup`. This will delete everything created by the E2E preparation.
up the E2E setup, run `make e2e-cleanup`.
This will delete everything created by the E2E preparation. If you've already created the cluster and the keys, and
you're actively testing new code, you may run `make e2e-images e2e-deploy test-e2e` to test your changes.

## Local build

Expand All @@ -173,8 +175,8 @@ CGO_ENABLED=0 GOOS=linux go build -a -ldflags '-extldflags "-static"' -o cosignw

## Credits

- Bruno Bressi <[email protected]>
- Frank Kloeker <[email protected]>
* Bruno Bressi <[email protected]>
* Frank Kloeker <[email protected]>

Life is for sharing. If you have an issue with the code or want to improve it, feel free to open an issue or an pull
request.
Expand Down

0 comments on commit 2e30275

Please sign in to comment.