(Makefile) remove-spaces command does not work on GNU system

[damsien]

What broke? What's expected?

This issue is related to the Makefile of Kubebuilder and not to the generated Makefile used for the operator.

The command make remove-spaces executed on a GNU system raises an error.

kubebuilder/Makefile

Lines 71 to 74 in e9beffb

	.PHONY: remove-spaces
	remove-spaces:
	@echo "Removing trailing spaces"
	@find . -type f -name "*.md" -exec sed -i '' 's/[[:space:]]*$$//' {} + || true

That is due to a difference between the sed of the GNU system and the OS X system (this command works well on MacOS). It is well explained here.

My proposal to solve this is to add a check of the system.

.PHONY: remove-spaces
remove-spaces:
	@echo "Removing trailing spaces"
        @SED_CMD="sed -i ''" && [ "$$(uname)" != "Darwin" ] && SED_CMD="sed -i"; \
	find . -type f -name "*.md" -exec $$SED_CMD 's/[[:space:]]*$$//' {} + || true

Reproducing this issue

No response

KubeBuilder (CLI) Version

4.3.1

PROJECT version

No response

Plugin versions

No response

Other versions

No response

Extra Labels

No response

[camilamacedo86]

that is working in the CI (which is ubuntu)
but I am fine with any change that works for mac and linux
feel free to open a pr with your suggestion

[damsien]

From what I saw in the .github/workflows, there is no call to the make remove-spaces command. This command is only called once by the make generate command.

kubebuilder/Makefile

Lines 66 to 69 in 20a9955

	.PHONY: generate
	generate: generate-testdata generate-docs ## Update/generate all mock data. You should run this commands to update the mock data after your changes.
	go mod tidy
	make remove-spaces

Correct me if I am wrong but the make generate command is never executed during the CI process.

PS: the "Trailing spaces" CI job only check for trailing spaces without trying to remove them (make test-spaces).

kubebuilder/.github/workflows/spaces.yml

Lines 11 to 21 in 20a9955

	jobs:
	lint:
	name: "Check Trailing"
	runs-on: ubuntu-latest
	# Pull requests from the same repository won't trigger this checks as they were already triggered by the push
	if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
	steps:
	- name: Clone the code
	uses: actions/checkout@v4
	- name: Run check
	run: make test-spaces

[damsien]

Should we keep this issue open? I wanted to show you the error. In the following screenshot, the first command is executed without the "fix" I made. And the second command is executed with the "fix".

The fix I made is wrong. I can try to find a friend that have a mac to actually test the command or wait for someone that want to take the issue.

[camilamacedo86]

HI @damsien

The way that it is today I know that work on Mac
So, could we not:

If is mac then do as it is today
else
do the way that worked for you in linux

WDYT?
Do you want to try it?
I can test locally the next one.

[damsien]

Yes we can do this, I'm not going to create the PR today but I'll work on it

[damsien]

/assign