Merge pull request #59 from CreMindES/feature/docker-image

Feature/docker image

Author: CreMindES

.dockerignore

@@ -0,0 +1 @@
+plugins/*

README.md

@@ -6,6 +6,8 @@
 
 Dockerfile linter written in Go.
 
+It provides static analysis for Dockerfiles, identifying common mistakes and promotes best practices.
+
 <p align="center">
   <img width="500px" src="docs/illustration/illustration.svg"/> 
 </p>
@@ -35,14 +37,15 @@ Each Dockerfile AST element has a corresponding set of rules. Click on the pictu
 | Configurable Output | | ![Done](https://img.shields.io/static/v1?label=&message=Done&color=Green)
 | - JSON | ![Done](https://img.shields.io/static/v1?label=&message=Done&color=Green) |
 | - Colored Summary | ![Done](https://img.shields.io/static/v1?label=&message=Done&color=Green) |
+| Docker image | | ![Done](https://img.shields.io/static/v1?label=&message=Done&color=Green) |
 | Rule pass | | ![NotYetStarted](https://img.shields.io/static/v1?label=&message=NoYetStarted&color=lightgrey) |
 | - Per line | ![NotYetStarted](https://img.shields.io/static/v1?label=&message=NoYetStarted&color=lightgrey) |
 | - Config file | ![NotYetStarted](https://img.shields.io/static/v1?label=&message=NoYetStarted&color=lightgrey) |
 | Config file | | ![NotYetStarted](https://img.shields.io/static/v1?label=&message=NoYetStarted&color=lightgrey) |
 | - Rule profiles | ![NotYetStarted](https://img.shields.io/static/v1?label=&message=NoYetStarted&color=lightgrey) |
 | IDE plugins/extensions | | ![InProgress](https://img.shields.io/static/v1?label=&message=InProgress&color=blue)
-| - VSCode | ![Preview](https://img.shields.io/static/v1?label=&message=Preview&color=blue)
-| - JetBrains | ![InProgress](https://img.shields.io/static/v1?label=&message=InProgress&color=blue)
+| - VSCode | ![PreviewRelease](https://img.shields.io/static/v1?label=&message=PreviewRelease&color=blue)
+| - JetBrains | ![PreviewRelease](https://img.shields.io/static/v1?label=&message=PreviewRelease&color=blue)
 
 ### Design Decisions
 
@@ -52,6 +55,17 @@ A collection of documents describing the thought process behind selected design
 
 [Link > TODO](docs/contribution/readme.md)
 
+## Docker Image
+
+![Docker imaage version](https://img.shields.io/docker/v/cremindes/whalelint)
+![DockerHub Downloads](https://img.shields.io/docker/pulls/cremindes/whalelint)
+![Docker image size](https://img.shields.io/docker/image-size/cremindes/whalelint)
+
+```bash
+docker pull cremindes/whalelint:[tag]
+docker run --rm -v $(pwd)/Dockerfile:/Dockerfile cremindes/whalelint:[tag] Dockerfile
+```
+
 ## Plugins
 
 ### JetBrains
@@ -63,7 +77,7 @@ A collection of documents describing the thought process behind selected design
   <img src="https://user-images.githubusercontent.com/5306361/110693878-3a926300-81e8-11eb-80c4-7041f2ecf675.gif"/>
 </p>
 
-*Note: make sure, to also install the [Docker plugin](https://plugins.jetbrains.com/plugin/7724-docker).
+*Note: make sure, to also install the [Docker plugin](https://plugins.jetbrains.com/plugin/7724-docker) in case it's not bundled with the IDE.
 
 ### VSCode
 

cli/cli.go

@@ -140,7 +140,7 @@ func (lspCommand *LspCommand) Run() error {
 type VersionCommand struct{}
 
 func (versionCommand *VersionCommand) Run(k *kong.Context) error {
-	version := "v0.0.6"
+	version := "v0.0.7"
 	k.Printf("%s", version)
 
 	return nil

cli/cli_test.go

@@ -67,7 +67,7 @@ func TestVersionCommand_Run(t *testing.T) {
 	err = ctx.Run()
 	assert.NilError(t, err)
 
-	assert.Equal(t, "whalelint: v0.0.6\n", stdBuffer.stdOut.String())
+	assert.Equal(t, "whalelint: v0.0.7\n", stdBuffer.stdOut.String())
 	assert.Equal(t, "", stdBuffer.stdErr.String())
 }
 

docker/Dockerfile

@@ -0,0 +1,26 @@
+FROM golang:1.15 as goBuilder
+
+COPY . /go/src/github.com/CreMindES/whalelint/
+
+WORKDIR /go/src/github.com/CreMindES/whalelint/
+RUN CGO_ENABLED=0 go build -o /app/whalelint
+
+FROM hairyhenderson/upx:3.96 as upxBuilder
+
+WORKDIR /app
+COPY --from=goBuilder /app/whalelint /app/whalelint
+RUN upx whalelint
+
+FROM scratch
+
+ARG gitCommitHash
+
+LABEL maintainer="Tamas Gabor Barna"
+LABEL source="https://github.com/CreMindES/whalelint"
+LABEL description="Dockerfile linter."
+LABEL revision=${gitCommitHash}
+
+COPY --from=upxBuilder /app/whalelint /usr/local/bin/
+
+CMD ["--help"]
+ENTRYPOINT ["/usr/local/bin/whalelint"]

docker/build.sh

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+
+docker build \
+  -f plugins/dockerhub/Dockerfile \
+  --no-cache \
+  --build-arg gitCommitHash=$(git rev-parse HEAD) \
+  -t cremindes/whalelint:latest \
+  .
+

docker/readme.md

@@ -0,0 +1,26 @@
+# <img width="22px" src="https://user-images.githubusercontent.com/5306361/110181582-6c807f80-7e0c-11eb-81c8-36d6a9c0db0b.png"> WhaleLint <img align="right" style="position: relative; top: 10px;" src="https://github.com/cremindes/whalelint/workflows/build/badge.svg" />
+
+Dockerfile linter written in Go.
+
+It provides static analysis for Dockerfiles, identifying common mistakes and promotes best practices.
+
+<p align="center">
+  <img width="500px" src="https://user-images.githubusercontent.com/5306361/110991142-870aa980-8374-11eb-8855-9f3ce400049e.png"/> 
+</p>
+
+## Usage
+
+```bash
+docker pull cremindes/whalelint:[tag]
+docker run --rm -v $(pwd)/Dockerfile:/Dockerfile cremindes/whalelint:[tag] Dockerfile
+```
+
+## Sample output
+
+<p align="center">
+  <img width="750px" src="https://user-images.githubusercontent.com/5306361/110198673-775f0280-7e54-11eb-8e4e-ab6350fb4e7d.png"/>
+</p>
+
+## GitHub
+
+[Official repository](https://github.com/CreMindES/whalelint) with further information.

docs/illustration/illustration.svg

@@ -9,7 +9,7 @@ plugins {
 }
 
 group = "WhaleLint"
-version = "0.0.6"
+version = "0.0.7"
 
 description = "WhaleLint is a Dockerfile linter written in Golang."
 
@@ -58,7 +58,7 @@ tasks.getByName<org.jetbrains.intellij.tasks.PatchPluginXmlTask>("patchPluginXml
             "<h2>Introduction</h2>", ""))
     }
 
-    version("0.0.6")
+    version("0.0.7")
 }
 
 tasks.withType<JavaCompile> {