Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: fix docs description header #22

Merged
merged 1 commit into from
Aug 30, 2023
Merged

chore: fix docs description header #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion DOCS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Description
## Description

This plugin uses [Grafana k6](https://k6.io/) to run performance tests in a Vela pipeline.

Expand Down
36 changes: 34 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ check-all:
@go fmt ./...

.PHONY: lint-all
lint-all: golangci-lint mdl yamllint
lint-all: golangci-lint mdl yamllint hadolint shellcheck codespell

.PHONY: clean-all
clean-all:
Expand Down Expand Up @@ -98,6 +98,16 @@ endif
@golangci-lint run ./...
@echo finished running golangci-lint

.PHONY: codespell
codespell:
ifeq ($(strip $(shell which codespell)),)
ifneq ($(strip $(shell which pip)),)
@pip install codespell
endif
endif
@codespell --skip node_modules,.git,public,package-lock.json,vendor
@echo finished running codespell

.PHONY: yamllint
yamllint:
ifeq ($(strip $(shell which yamllint)),)
Expand All @@ -108,14 +118,36 @@ endif
@yamllint -f colored -c .yamllint.yml .
@echo finished running yamllint

.PHONY: hadolint
hadolint:
ifeq ($(strip $(shell which hadolint)),)
ifeq ($(shell uname -s), Darwin)
@brew install hadolint
endif
endif
@hadolint --ignore DL3018 --ignore DL3007 ./Dockerfile
@echo finished running hadolint

.PHONY: shellcheck
shellcheck:
ifeq ($(strip $(shell which shellcheck)),)
ifeq ($(shell uname -s), Darwin)
@brew install shellcheck
endif
endif
@find . -name \*.sh ! -path "./vendor/*" | xargs -I {} shellcheck {}
@echo finished running shellcheck

.PHONY: mdl
mdl:
ifeq ($(strip $(shell which mdl)),)
ifneq ($(strip $(shell which gem)),)
@gem install mdl
endif
endif
@mdl -g --rules ~MD007,~MD013 .
@find . -name '*.md' ! -name "DOCS.md" ! -path "./vendor/*" | xargs mdl --rules ~MD007,~MD013
# ignore top level header for docs
@mdl DOCS.md --rules ~MD007,~MD013,~MD002
@echo finished running mdl

# The `build-all` target is intended to compile
Expand Down