chore(formatting): fix infected files with correct formatting #5099

ivankatliarchuk · 2025-02-16T14:57:43Z

Description

fixed missed link. Probably worth to add Markdown link checker action https://github.com/marketplace/actions/markdown-link-check
Updated .editorconfig with recommended for golang configuration. Otherwise reviewing tabs changes....
Added local and GA linter config validation. Example GA failed validation https://github.com/kubernetes-sigs/external-dns/actions/runs/13356353245/job/37299652842?pr=5099

Found the issue in this pull request https://github.com/kubernetes-sigs/external-dns/pull/5097/files#r1957067735

Checklist

Unit tests updated
End user documentation updated

Signed-off-by: ivan katliarchuk <[email protected]>

ivankatliarchuk · 2025-02-16T15:16:05Z

Linter fix is here #5085

example fix

linters-settings:
  # Remove or correct the 'maligned' property
  goimports:
    local-prefixes: github.com/kubernetes-sigs/external-dns

run:
  # Remove or correct the 'exclude-files' property
  skip-dirs:
    - vendor
    - internal

Signed-off-by: ivan katliarchuk <[email protected]>

ivankatliarchuk · 2025-02-16T15:44:42Z

/label tide/merge-method-squash

mloiseleur · 2025-02-16T18:11:25Z

.github/workflows/lint.yaml

      with:
        go-version-file: go.mod

+    # https://github.com/golangci/golangci-lint-action?tab=readme-ov-file#verify


Wdyt about adding verify: true in current golangci lint action instead of creating a new one ?

Changed. First impression was, that it does not support both operation, but looks like it does. Validated here https://github.com/golangci/golangci-lint-action/blob/3b4f037d0e94e85d98f9824ef87b2dc32d53fbd5/src/run.ts#L140

mloiseleur · 2025-02-16T18:16:42Z

.editorconfig

+# https://github.com/editorconfig/editorconfig-core-go/blob/master/.editorconfig
+[{Makefile,go.mod,go.sum,*.go,.gitmodules}]
 indent_style = tab
+indent_size = 4


Current indent_size on all go files in master is 2.
Why would we want to change it to 4 ? It would force to update all codebase and force all PRs to rebase.

side note: there are no gitmodules in this project

Removed submodules.
I've added gofmt -l -s -w . to go-lint docs https://pkg.go.dev/cmd/gofmt

I only found this few files that

have issues with intendations, rest of them are fine

Shell we add gofmt validation to github actions?

Some inspirations from kubernetes-sigs https://github.com/search?q=org%3Akubernetes-sigs+gofmt&type=code&p=3

Current indent_size on all go files in master is 2. Why would we want to change it to 4 ? It would force to update all codebase and force all PRs to rebase.

side note: there are no gitmodules in this project

Golang is 4 tabs intendation, which is set across the project.

cmd/gofmt: remove -tabs and -tabwidth flags golang/go#7101

The proper Go style way to do this is to configure your editor's display of tabs instead.

Is it shows 2 spaces in your editor?

When I checked yesterday, it was displaying 2 spaces.
Today, it display 4 spaces, as you say 😅 .

Shall we add gofmt validation to github actions?

Yes, it sounds good 👍 .

Gofmt github action step in action https://github.com/kubernetes-sigs/external-dns/actions/runs/13366428004/job/37325125200?pr=5099

Signed-off-by: ivan katliarchuk <[email protected]>

mloiseleur · 2025-02-17T08:53:21Z

@ivankatliarchuk You'll need to fix the config of golangci-lint and we should be good to go.

Signed-off-by: ivan katliarchuk <[email protected]>

ivankatliarchuk · 2025-02-17T09:03:53Z

Fixed .golangci.yaml file

mloiseleur

LGTM

k8s-ci-robot · 2025-02-18T09:20:00Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mloiseleur

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [mloiseleur]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

* master: (97 commits) chore(formatting): fix infected files with correct formatting (kubernetes-sigs#5099) docs: Fix managed-record-type argument docs(proposal): support multiple replicas with leader election (kubernetes-sigs#5051) feat(chart): automate helm json schema (kubernetes-sigs#5075) docs(proposal): update proposal template, add statuses test(aws): introduce first fixture-based (kubernetes-sigs#5092) chore(makefile): add helper and document targets feat: Updated chart for v1.15.2 release chore(makefile): add helper and document targets chore(filter-tags): pre-process filter tags chore(filter-tags): pre-process filter tags chore(filter-tags): pre-process filter tags chore(deps): bump the dev-dependencies group across 1 directory with 21 updates test(domain-filter): simple filters on domain exclusion (kubernetes-sigs#5064) chore(deps): bump nosborn/github-action-markdown-cli ci(docs): add markdown linters and editorconfig (kubernetes-sigs#5055) Address PR comments docs: update and refactor contribution part (kubernetes-sigs#5073) fix(chart): update rbac for F5 transportserver source (kubernetes-sigs#5066) fix(chart): non-string types on svcaccount annotations (kubernetes-sigs#5067) ...

* master: (31 commits) fix(source): debug log on gateway target detection Update docs/sources/service.md chore(formatting): fix infected files with correct formatting (kubernetes-sigs#5099) docs: Fix managed-record-type argument Update docs/sources/service.md docs(proposal): support multiple replicas with leader election (kubernetes-sigs#5051) fixed golangci-lint config updated MD files updated MD files feat(chart): automate helm json schema (kubernetes-sigs#5075) docs(proposal): update proposal template, add statuses test(aws): introduce first fixture-based (kubernetes-sigs#5092) chore(makefile): add helper and document targets feat: Updated chart for v1.15.2 release chore(makefile): add helper and document targets chore(filter-tags): pre-process filter tags chore(filter-tags): pre-process filter tags chore(filter-tags): pre-process filter tags chore(deps): bump the dev-dependencies group across 1 directory with 21 updates update service.md, service.go ...

* master: (80 commits) chore(deps): bump the dev-dependencies group across 1 directory with 7 updates Update README.md with proper link to dev guide Add OpenStack Designate webook provider to readme chore(deps): bump the dev-dependencies group with 3 updates chore(deps): bump the dev-dependencies group with 20 updates chore(deps): bump azure/setup-helm in the dev-dependencies group style: formatting fix: remove broken test fix test name chore: upgrade ExternalDNS to go 1.24 chore-makefile-coverage cover source.go getProviderSpecificAnnotations() with unit tests nitpick: rename cloudflare custom hostname test function review suggestions based improvements review suggestions fix(source): debug log on gateway target detection improve error message phrasing Update docs/sources/service.md chore(formatting): fix infected files with correct formatting (kubernetes-sigs#5099) docs: Fix managed-record-type argument ...

chore(format): fix go formatting

3838513

Signed-off-by: ivan katliarchuk <[email protected]>

k8s-ci-robot requested review from mloiseleur and szuecs February 16, 2025 14:57

k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 16, 2025

ivankatliarchuk changed the title ~~chore(format): fix go formatting~~ chore(formatting): fix infected files with correct formatting Feb 16, 2025

chore(format): linter check configuration

971c685

Signed-off-by: ivan katliarchuk <[email protected]>

k8s-ci-robot added the tide/merge-method-squash Denotes a PR that should be squashed by tide when it merges. label Feb 16, 2025

mloiseleur reviewed Feb 16, 2025

View reviewed changes

ivankatliarchuk added 3 commits February 17, 2025 08:27

chore(formatting): fix infected files with correct formatting

eaa6ff0

Signed-off-by: ivan katliarchuk <[email protected]>

chore(formatting): fix infected files with correct formatting

2b5cfe7

Signed-off-by: ivan katliarchuk <[email protected]>

chore(formatting): fix infected files with correct formatting

a0f898e

Signed-off-by: ivan katliarchuk <[email protected]>

ivankatliarchuk requested a review from mloiseleur February 17, 2025 08:46

ivankatliarchuk added 2 commits February 17, 2025 08:56

chore(formatting): fix infected files with correct formatting

a499801

Signed-off-by: ivan katliarchuk <[email protected]>

chore(formatting): fix infected files with correct formatting

5e28708

Signed-off-by: ivan katliarchuk <[email protected]>

mloiseleur approved these changes Feb 18, 2025

View reviewed changes

k8s-ci-robot assigned mloiseleur Feb 18, 2025

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Feb 18, 2025

k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Feb 18, 2025

k8s-ci-robot merged commit 99b9d0d into kubernetes-sigs:master Feb 18, 2025
13 checks passed

mloiseleur mentioned this pull request Feb 18, 2025

chore: update maintainers/reviewers #5020

Merged

2 tasks

chore(formatting): fix infected files with correct formatting #5099

chore(formatting): fix infected files with correct formatting #5099

Uh oh!

Conversation

ivankatliarchuk commented Feb 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ivankatliarchuk commented Feb 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ivankatliarchuk commented Feb 16, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ivankatliarchuk Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ivankatliarchuk Feb 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mloiseleur commented Feb 17, 2025

Uh oh!

ivankatliarchuk commented Feb 17, 2025

Uh oh!

mloiseleur left a comment

Choose a reason for hiding this comment

Uh oh!

k8s-ci-robot commented Feb 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ivankatliarchuk commented Feb 16, 2025 •

edited

Loading

ivankatliarchuk commented Feb 16, 2025 •

edited

Loading

ivankatliarchuk Feb 17, 2025 •

edited

Loading

ivankatliarchuk Feb 17, 2025 •

edited

Loading