Merge pull request #2 from golangci/release-04-26

Update readme and action

.github/workflows/dockerimage.yml

@@ -1,4 +1,4 @@
-name: Docker Image CI
+name: docker image
 
 on: [push]
 

.github/workflows/golangci.yml

@@ -0,0 +1,15 @@
+name: golangci
+on: [pull_request]
+jobs:
+  golangci-lint-dockerfile:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v1
+      - name: golangci-lint
+        uses: ./
+        with:
+          directory: sample
+          format: colored-line-number
+          flags: --issues-exit-code 0

Dockerfile

@@ -1 +1,5 @@
 FROM golangci/golangci-lint:v1.25
+
+COPY entrypoint.sh /entrypoint.sh
+
+ENTRYPOINT ["/entrypoint.sh"]

README.md

@@ -1,3 +1,25 @@
 # golangci-lint-action
 
-Work in progress
+![docker image](https://github.com/golangci/golangci-lint-action/workflows/docker%20image/badge.svg)
+
+Action that runs [golangci-lint](https://github.com/golangci/golangci-lint) and reports issues from linters.
+
+You can put `.github/workflows/lint.yml` with following contents:
+```yaml
+name: golangci
+on: [push]
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check out code into the Go module directory
+        uses: actions/checkout@v1
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v0.0.2
+        with:
+          github_token: ${{ secrets.github_token }}
+
+```
+
+Based on [reviewdog action](https://github.com/reviewdog/action-golangci-lint).

action.yml

@@ -5,7 +5,20 @@ author: 'golangci'
 inputs:
   github_token:
     description: 'GITHUB_TOKEN'
-    required: true
+    required: false
+  flags:
+    description: 'GolangCI command line flags'
+    required: false
+  directory:
+    description: 'Working directory'
+    required: false
+    default: ''
+  format:
+    description: 'Output format of issues'
+    default: 'github-actions'
+    required: false
+
+
 runs:
   using: 'docker'
   image: 'Dockerfile'

entrypoint.sh

@@ -1,3 +1,10 @@
 #!/bin/bash
 
-golangci-lint run --out-format github-actions
+echo 'golangci-lint-action: start'
+echo " flags:  ${INPUT_FLAGS}"
+echo " format: ${INPUT_FORMAT}"
+
+cd "${GITHUB_WORKSPACE}/${INPUT_DIRECTORY}" || exit 1
+
+# shellcheck disable=SC2086
+golangci-lint run --out-format ${INPUT_FORMAT} ${INPUT_FLAGS}

sample/sample.go

@@ -0,0 +1,14 @@
+// Package sample is used as test input for golangci action.
+package sample
+
+import (
+	"crypto/md5"
+	"encoding/hex"
+)
+
+// Hash~
+func Hash(data string) string {
+	h := md5.New()
+	h.Write([]byte(data))
+	return hex.EncodeToString(h.Sum(nil))
+}