Skip to content

feat(template): add editorconfig auto-fix target and use it in CI (issue 76) #186

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

Closed
bacluc-agent wants to merge 1 commit into from
Closed

feat(template): add editorconfig auto-fix target and use it in CI (issue 76) #186

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
11 changes: 11 additions & 0 deletions renovate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,17 @@
"config:base",
":disableDependencyDashboard"
],
"customManagers": [
{
"customType": "regex",
"managerFilePatterns": [
"/^\\{\\{ cookiecutter\\.slug \\}\\}/Makefile\\.vars\\.mk$/"
],
"matchStrings": [
"# renovate: datasource=(?<datasource>\\S+) depName=(?<depName>\\S+)\\n[a-zA-Z0-9_]+ \\?= (?<currentValue>\\S+)"
]
}
],
"poetry": {
"enabled": true
},
Expand Down
2 changes: 1 addition & 1 deletion {{ cookiecutter.slug }}/.github/changelog-configuration.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,4 +29,4 @@
],
"template": "${{CATEGORIZED_COUNT}} changes since ${{FROM_TAG}}\n\n${{CHANGELOG}}"
}
{% endraw %}
{% endraw -%}
7 changes: 4 additions & 3 deletions {{ cookiecutter.slug }}/.github/workflows/test.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- uses: snow-actions/eclint@v1.0.1
with:
args: 'check'
- name: Check EditorConfig conformance
run: |
make format_editorconfig
git diff --exit-code
test:
runs-on: ubuntu-latest
{%- if cookiecutter.add_matrix == "y" %}
Expand Down
6 changes: 5 additions & 1 deletion {{ cookiecutter.slug }}/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,12 +36,16 @@ lint_kubent: ## Check for deprecated Kubernetes API versions
{%- endif %}

.PHONY: format
format: format_jsonnet ## All-in-one formatting
format: format_jsonnet format_editorconfig ## All-in-one formatting

.PHONY: format_jsonnet
format_jsonnet: $(JSONNET_FILES) ## Format jsonnet files
$(JSONNET_DOCKER) $(JSONNETFMT_ARGS) --in-place -- $?

.PHONY: format_editorconfig
format_editorconfig: ## Fix EditorConfig issues
npx --yes eclint@$(ECLINT_VERSION) fix .

.PHONY: docs-serve
docs-serve: ## Preview the documentation
$(ANTORA_PREVIEW_CMD)
Expand Down
3 changes: 3 additions & 0 deletions {{ cookiecutter.slug }}/Makefile.vars.mk
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,9 @@ YAMLLINT_DOCKER ?= $(DOCKER_CMD) $(DOCKER_ARGS) $(root_volume) $(YAMLLINT_IMAGE)
VALE_CMD ?= $(DOCKER_CMD) $(DOCKER_ARGS) $(root_volume) --volume "$${PWD}"/docs/modules:/pages ghcr.io/vshn/vale:2.15.5
VALE_ARGS ?= --minAlertLevel=error --config=/pages/ROOT/pages/.vale.ini /pages

# renovate: datasource=npm depName=eclint
ECLINT_VERSION ?= 2.8.1

ANTORA_PREVIEW_CMD ?= $(DOCKER_CMD) run --rm --publish 35729:35729 --publish 2020:2020 $(antora_git_volume) --volume "${PWD}/docs":/preview/antora/docs ghcr.io/vshn/antora-preview:3.1.2.3 --style=syn --antora=docs

COMMODORE_CMD ?= $(DOCKER_CMD) $(DOCKER_ARGS) $(git_volume) $(root_volume) docker.io/projectsyn/commodore:latest
Expand Down