Skip to content

Commit

Permalink
chore(docs): fix lint issues
Browse files Browse the repository at this point in the history
Signed-off-by: Emilien Escalle <[email protected]>
  • Loading branch information
neilime committed Nov 12, 2024
1 parent 22b27bf commit a5cbe29
Show file tree
Hide file tree
Showing 7 changed files with 62 additions and 9 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
name: Bug report
about: Create a bug report
title: ''
title: ""
labels: bug, needs triage
assignees: ''
assignees: ""
---

<!--- Please direct any generic questions related to actions to our support community forum at https://github.community/c/code-to-cloud/github-actions/41 --->
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''
title: ""
labels: ""
assignees: ""
---

**Is your feature request related to a problem? Please describe.** A clear and
Expand Down
4 changes: 2 additions & 2 deletions .github/ghadocs/examples/1_environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ steps:
- uses: actions/checkout@v4
- uses: hoverkraft-tech/[email protected]
with:
compose-file: './docker/docker-compose.yml'
compose-file: "./docker/docker-compose.yml"
env:
CUSTOM_VARIABLE: 'test'
CUSTOM_VARIABLE: "test"
```
2 changes: 1 addition & 1 deletion .github/ghadocs/examples/2_services.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ steps:
- uses: actions/checkout@v3
- uses: hoverkraft-tech/[email protected]
with:
compose-file: './docker/docker-compose.yml'
compose-file: "./docker/docker-compose.yml"
services: |
helloworld2
helloworld3
Expand Down
2 changes: 1 addition & 1 deletion .github/ghadocs/examples/5_compose-flags.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ steps:
- uses: actions/checkout@v3
- uses: hoverkraft-tech/[email protected]
with:
compose-file: './docker/docker-compose.yml'
compose-file: "./docker/docker-compose.yml"
services: |
helloworld2
helloworld3
Expand Down
11 changes: 11 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
#checkov:skip=CKV_DOCKER_2: required
FROM ghcr.io/super-linter/super-linter:slim-v7

ARG UID=1000
ARG GID=1000
USER ${UID}:${GID}

ENV RUN_LOCAL=true
ENV USE_FIND_ALGORITHM=true
ENV LOG_LEVEL=WARN
ENV LOG_FILE="../logs"
42 changes: 42 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
.PHONY: help

help: ## Display help
@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'

lint: ## Execute linting
$(call run_linter,)

lint-fix: ## Execute linting and fix
$(call run_linter, \
-e FIX_YAML_PRETTIER=true \
-e FIX_MARKDOWN=true \
-e FIX_JSON_PRETTIER=true \
-e FIX_MARKDOWN_PRETTIER=true \
-e FIX_NATURAL_LANGUAGE=true)

define run_linter
DEFAULT_WORKSPACE="$(CURDIR)"; \
LINTER_IMAGE="linter:latest"; \
VOLUME="$$DEFAULT_WORKSPACE:$$DEFAULT_WORKSPACE"; \
docker build --build-arg UID=$(id -u) --build-arg GID=$(id -g) --tag $$LINTER_IMAGE .; \
docker run \
-e DEFAULT_WORKSPACE="$$DEFAULT_WORKSPACE" \
-e FILTER_REGEX_INCLUDE="$(filter-out $@,$(MAKECMDGOALS))" \
-e FILTER_REGEX_EXCLUDE=dist/**/* \
-e VALIDATE_JSCPD=false \
-e VALIDATE_TYPESCRIPT_STANDARD=false \
-e VALIDATE_TYPESCRIPT_ES=false \
-e VALIDATE_TYPESCRIPT_PRETTIER=false \
-e VALIDATE_JAVASCRIPT_ES=false \
-e VALIDATE_JAVASCRIPT_STANDARD=false \
$(1) \
-v $$VOLUME \
--rm \
$$LINTER_IMAGE
endef

#############################
# Argument fix workaround
#############################
%:
@:

0 comments on commit a5cbe29

Please sign in to comment.