ci: add fix-yamllint rule in Makefile

[tao12345666333]

Please read https://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md#contribution-flow.

follow-up #15955

Two rules have been specified for yamlfmt here:

• Automatically add the header --- to YAML files.
• Preserve line breaks.

ref: https://github.com/google/yamlfmt/blob/main/docs/config-file.md#configuration-1

[jmhbnz]

Should we move this configuration file out of the root directory to reduce initial clutter?

It's possible to specify the file location via https://github.com/google/yamlfmt/blob/main/docs/command-usage.md#configuration-flags

It could sit under /tools or /tests instead perhaps. Just an idea given we have been discussing tidying root directory.

In hindsight we could actually do the same for yamllint https://yamllint.readthedocs.io/en/stable/configuration.html.

[tao12345666333]

Thank you for your suggestion. Using parameters can indeed reduce the content of the root directory.

There are several reasons why I use configuration files:

• These configuration files are hidden by default, and most people will not see them directly;
• The names of these configuration files are very intuitive, and their functions can be understood through their names.

The difference from #15778 is that we expect yamllint and yamlfmt to be triggered through make, so there is no need to touch these configuration files.
But the Procfile file is included in the documentation, and people need to understand its function and significance.

If modifications are needed, I can make adjustments. yamlfmt passes parameters through flags, and the configuration file for yamllint is located in either the tools or scripts directory.

[jmhbnz]

Thanks @tao12345666333, my preference would be to:

1. Move .yamllint and .yamlfmt to tools/...
2. Update Makefile as follows:

verify-yamllint:
-	yamllint .
+      yamllint --config-file tools/.yamllint .

fix-yamllint:
ifeq (, $(shell which yamlfmt))
	$(shell go install github.com/google/yamlfmt/cmd/yamlfmt@latest)
endif
-	yamlfmt .
+      yamlfmt -conf tools/.yamlfmt .

[tao12345666333]

Addressed!

[serathius]

Agree with the proposed direction. @jmhbnz Can you file an issue to consider moving other dotfiles?

[serathius]

FYI there is also hack directory borrowed from kubernetes that serves similar purpose.

[jmhbnz]

Issue raised #15987. @tao12345666333 you are most welcome to work on that one next once this merges, just let me know if you are interested and I can assign it to you :)

[ahrtr]

Don't like the idea of putting the config files under hack.

#15987 (comment)

[jmhbnz]

LGTM

[fuweid]

LGTM

[ahrtr]

Overall looks good to me with a minor comment #15987 (comment).

Thanks @tao12345666333 and @jmhbnz

[jmhbnz]

Hey @ahrtr - Are we ok to merge this now?

Noting we have a decision to make under #15987 about where the config files are going to live, however it would be nice to get this makefile fix functionality merged and close down #15955.

[ahrtr]

Just as I mentioned in #15987 (comment), I don't think it's good to put the config files under hack. The utilities & scripts under hack are various hacks which are used by developers (just for developers reference); while all tools under tools are used by etcd itself. Removing anything under tools will break the etcd (e.g. build, workflow check etc), but removing anything under hack will not impact etcd itself at all.

[jmhbnz]

Just as I mentioned in #15987 (comment), I don't think it's good to put the config files under hack.

Thanks for sharing your perspective re hack, note this pr does not propose anything under that directory.

[tao12345666333]

So can we merge this PR by moving the config files currently in the tools root directory to the tools/config directory?

I personally don't have a strong preference for these two positions.

[ahrtr]

I am OK as long as the config files are under tools instead of hack, thanks.