Add go linting tools to CI

[vharsh]

Background

GolangCI-lint is a popular linter for go-projects which has support for a lot of popular linters like govet, golint, gofmt, etc, so it gets a bit easier than having to write individual shell scripts & complex Makefiles. It's super configurable so it's warnings can be silenced & it runs with similar toggles locally, i.e. the config file works well for the local development & CI.

It has a host of tools like golint, gofmt, govet and a bunch of unofficial tools like dupl, depguard, etc which should be added. Per the docs, using the official golangci-lint action might turn out to be a better approach than adding it via the Makefile in some other action/job.

[burntcarrot]

@vharsh I'd like to work on this, could you assign me?

[burntcarrot]

I'm not sure where the Verify License task should go.

openebsctl/.github/workflows/go.yml

Lines 5 to 23 in 9001fb0

	lint:
	name: Golint
	runs-on: ubuntu-latest
	steps:
	- name: Set up Go 1.16
	uses: actions/setup-go@v2
	with:
	go-version: 1.16
	id: go_1
	- name: Checkout
	uses: actions/checkout@v2
	- name: Run Golint
	run: make golint
	- name: Verify License
	run: make license-check

And should this section be completely removed from the Makefile?

openebsctl/Makefile

Lines 66 to 73 in 9001fb0

	.PHONY: golint
	golint:
	@echo "+ Installing golint"
	@GO111MODULE=on go get -u golang.org/x/lint/golint;
	@echo "--> Running golint"
	@golint -set_exit_status $(PACKAGES)
	@echo "Golint successful !"
	@echo "--------------------------------"

Can you please clarify this?

[vharsh]

@burntcarrot You can move the license checking part to goheader via GolangCI-lint & remove it from the go workflow.

Regarding the golint: target in Makefile, you can replace it with the golangci-lint run command & rename golint to golangci in Makefile