⚠️ go/v4-alpha: change the layout to follow Golang Standards

[camilamacedo86]

Description

• The directory apis was renamed to api to follow the standard
• The controller(s) directory has been moved under a new directory called internal and renamed to singular as well controller
• The main.go previously scaffolded in the root directory has been moved under a new directory called cmd

Therefore, you can check the changes in the layout results into:

...
├── cmd
│ └── main.go
├── internal
│ └── controller
└── api

Motivation

Closes: #932

[camilamacedo86]

/hold

To allow more reviews.

[erikgb]

/hold
/lgtm

Nice work, @camilamacedo86! 👏 The suggested new structure summarized in the PR description is what I prefer. Putting the PR on hold for now, to allow for additional reviews.

[everettraven]

Just some minor docs nits

[k8s-ci-robot]

New changes are detected. LGTM label has been removed.

[camilamacedo86]

Hi @erikgb,

I am removing the hold to clarify that flying is good because this one will need to be forced. (the API diff check fails for the changes in the alpha go plugin). So, it is safe. Also, we already have a lot of OKs and approvals, and we did what was agreed upon here, but let's wait for a little to see if others come up.

/hold cancel

[wI2L]

I'd like to add one more thing regarding the move of the main.go file to the cmd/ directory. While I don't have a strong opinion about the name of the file itself, I think it is idiomatic to put the "main" Go file in a sub-directory of cmd/ which is named after the binary it should produce: cmd/foo/main.go.

Whether this would default to the name of the project, or something generic like operator is open to discussion. Personally, I would prefer that it follows the name of the project.

[camilamacedo86]

Hi @wI2L,

I'd like to add one more thing regarding the move of the main.go file to the cmd/ directory. While I don't have a strong opinion about the name of the file itself, I think it is idiomatic to put the "main" Go file in a sub-directory of cmd/ which is named after the binary it should produce: cmd/foo/main.go.
Whether this would default to the name of the project, or something generic like operator is open to discussion. Personally, I would prefer that it follows the name of the project.

It was never considered in the proposal and discussions.

If you would like that, could you please raise an issue and also add why do think that should be made?
What is your motivation to be looking for that? what docs/references would describe it as good practice?
Why would we need to create another subdirectory by default inside of the cmd?

Then, we can bring a specific discussion about this one and decide if we all convey or not to do this change. if so, that can be done a follow-up before the go/v4-alpha plugin is stabilized.

Thank you a lot for your attention and input.

[camilamacedo86]

I am moving forward with this one since:

a) It changes the default layout only for go/v4-alpha as conveyed in the discussion: #2985 (comment) (@joelanford suggestion)

b) It has the lgtm from

• @umangachapagain
  umangachapagain
• @Kavinjsir
• @erikgb
• @everettraven
• @jakob Möller
• @varshaprasad96

Therefore, it seems OK to move forward, but we can address any change/improvement in a follow if required.