From 71dc03b35c6a1e0ea24d4fd4e452324bf9fd0cc6 Mon Sep 17 00:00:00 2001 From: Eray Ates Date: Fri, 20 Sep 2024 21:30:10 +0200 Subject: [PATCH] chore: update README Signed-off-by: Eray Ates --- .github/workflows/test.yml | 6 +++--- Makefile | 14 +++----------- README.md | 5 ++--- 3 files changed, 8 insertions(+), 17 deletions(-) diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 4ce83a2..40503a3 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -11,15 +11,15 @@ jobs: sonarcloud: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v4 with: # Disabling shallow clone is recommended for improving relevancy of reporting fetch-depth: 0 - - uses: actions/setup-go@v3 + - uses: actions/setup-go@v5 with: go-version: '1.18' # The Go version to download (if necessary) and use. - name: golangci-lint - uses: golangci/golangci-lint-action@v3 + uses: golangci/golangci-lint-action@v6 - name: Run tests run: | golangci-lint run --out-format checkstyle ./... > golangci-lint-report.out diff --git a/Makefile b/Makefile index e15ba38..e01daf3 100644 --- a/Makefile +++ b/Makefile @@ -1,22 +1,14 @@ .DEFAULT_GOAL := help -.PHONY: test coverage help html html-gen html-wsl - +.PHONY: test test: ## Run unit tests @go test -race ./... +.PHONY: coverage coverage: ## Run unit tests with coverage @go test -v -race -cover -coverpkg=./... -coverprofile=coverage.out -covermode=atomic ./... @go tool cover -func=coverage.out -html: - @go tool cover -html=./coverage.out - -html-gen: ## explorer.exe ./coverage.html - @go tool cover -html=./coverage.out -o ./coverage.html - -html-wsl: html-gen ## wslview ./coverage.html - @explorer.exe `wslpath -w ./coverage.html` || true - +.PHONY: html help: ## Display this help screen @grep -h -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}' \ No newline at end of file diff --git a/README.md b/README.md index 4ac10bd..e3c332f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,9 @@ ![call](https://raw.githubusercontent.com/rytsh/call/pages/static/logo/call.svg) -[![License](https://img.shields.io/github/license/rytsh/call?color=red&style=flat-square)](https://raw.githubusercontent.com/rytsh/call/main/LICENSE) -[![Sonar Coverage](https://img.shields.io/sonar/coverage/rytsh_call?logo=sonarcloud&server=https%3A%2F%2Fsonarcloud.io&style=flat-square)](https://sonarcloud.io/summary/overall?id=rytsh_call) +[![License](https://img.shields.io/github/license/rytsh/call?color=blue&style=flat-square)](https://raw.githubusercontent.com/rytsh/call/main/LICENSE) +[![Coverage](https://img.shields.io/sonar/coverage/rytsh_call?logo=sonarcloud&server=https%3A%2F%2Fsonarcloud.io&style=flat-square)](https://sonarcloud.io/summary/overall?id=rytsh_call) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/rytsh/call/test.yml?branch=main&logo=github&style=flat-square&label=ci)](https://github.com/rytsh/call/actions) [![Go Report Card](https://goreportcard.com/badge/github.com/rytsh/call?style=flat-square)](https://goreportcard.com/report/github.com/rytsh/call) -[![Go PKG](https://raw.githubusercontent.com/rytsh/call/pages/assets/reference.svg)](https://pkg.go.dev/github.com/rytsh/call) [![Web](https://img.shields.io/badge/web-document-blueviolet?style=flat-square)](https://rytsh.github.io/call/) __Call__ dependency injection library based on registry arguments and functions.