From 9bd5feb86b5817aa6072b008f9866a2c3bbc8587 Mon Sep 17 00:00:00 2001 From: Zhenxu Ke Date: Tue, 12 Jan 2021 17:28:04 +0800 Subject: [PATCH] Add documentation about how to use via docker image (#20) --- Dockerfile | 2 ++ README.md | 8 +++++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index f7090f6..ef95f9a 100644 --- a/Dockerfile +++ b/Dockerfile @@ -16,6 +16,8 @@ # under the License. # +# TODO: minimize the docker image size, now 524MB !!! + FROM golang:1.14.3-alpine AS build WORKDIR /license-eye diff --git a/README.md b/README.md index f35bd38..33fa06c 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,13 @@ header: **NOTE**: The full configurations can be found in [the configuration section](#configurations). +### Docker Image + +```shell +$ docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header check +$ docker run -it --rm -v $(pwd):/github/workspace apache/skywalking-eyes header fix +``` + ### Compile from Source ```bash @@ -119,7 +126,6 @@ ERROR failed to identify the licenses of following packages: gopkg.in/yaml.v3 ``` - ## Configurations ```yaml