Skip to content

Commit 0e48233

Browse files
Improve maintainability by aligning internal layout: move main.go boilerplate to cmd/ directory
Moves main.go boilerplate to the cmd/ directory to align the project structure with scaffolded templates, ensuring consistency and maintainability.
1 parent f7a02ad commit 0e48233

File tree

4 files changed

+7
-6
lines changed

4 files changed

+7
-6
lines changed

pkg/plugins/golang/v4/scaffolds/api.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ package scaffolds
1919
import (
2020
"errors"
2121
"fmt"
22+
"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/v4/scaffolds/internal/templates/cmd"
2223

2324
log "github.com/sirupsen/logrus"
2425
"github.com/spf13/afero"
@@ -27,7 +28,6 @@ import (
2728
"sigs.k8s.io/kubebuilder/v4/pkg/machinery"
2829
"sigs.k8s.io/kubebuilder/v4/pkg/model/resource"
2930
"sigs.k8s.io/kubebuilder/v4/pkg/plugins"
30-
"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/v4/scaffolds/internal/templates"
3131
"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/v4/scaffolds/internal/templates/api"
3232
"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/v4/scaffolds/internal/templates/controllers"
3333
"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/v4/scaffolds/internal/templates/hack"
@@ -111,7 +111,7 @@ func (s *apiScaffolder) Scaffold() error {
111111
}
112112

113113
if err := scaffold.Execute(
114-
&templates.MainUpdater{WireResource: doAPI, WireController: doController},
114+
&cmd.MainUpdater{WireResource: doAPI, WireController: doController},
115115
); err != nil {
116116
return fmt.Errorf("error updating cmd/main.go: %v", err)
117117
}

pkg/plugins/golang/v4/scaffolds/init.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ package scaffolds
1818

1919
import (
2020
"fmt"
21+
"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/v4/scaffolds/internal/templates/cmd"
2122
"strings"
2223

2324
log "github.com/sirupsen/logrus"
@@ -141,7 +142,7 @@ func (s *initScaffolder) Scaffold() error {
141142
}
142143

143144
return scaffold.Execute(
144-
&templates.Main{
145+
&cmd.Main{
145146
ControllerRuntimeVersion: ControllerRuntimeVersion,
146147
},
147148
&templates.GoMod{

pkg/plugins/golang/v4/scaffolds/internal/templates/main.go renamed to pkg/plugins/golang/v4/scaffolds/internal/templates/cmd/main.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ See the License for the specific language governing permissions and
1414
limitations under the License.
1515
*/
1616

17-
package templates
17+
package cmd
1818

1919
import (
2020
"fmt"

pkg/plugins/golang/v4/scaffolds/webhook.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ package scaffolds
1818

1919
import (
2020
"fmt"
21+
"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/v4/scaffolds/internal/templates/cmd"
2122

2223
log "github.com/sirupsen/logrus"
2324
"github.com/spf13/afero"
@@ -27,7 +28,6 @@ import (
2728
"sigs.k8s.io/kubebuilder/v4/pkg/model/resource"
2829
pluginutil "sigs.k8s.io/kubebuilder/v4/pkg/plugin/util"
2930
"sigs.k8s.io/kubebuilder/v4/pkg/plugins"
30-
"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/v4/scaffolds/internal/templates"
3131
"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/v4/scaffolds/internal/templates/hack"
3232
"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/v4/scaffolds/internal/templates/test/e2e"
3333
"sigs.k8s.io/kubebuilder/v4/pkg/plugins/golang/v4/scaffolds/internal/templates/webhooks"
@@ -95,7 +95,7 @@ func (s *webhookScaffolder) Scaffold() error {
9595
if err := scaffold.Execute(
9696
&webhooks.Webhook{Force: s.force, IsLegacyPath: s.isLegacy},
9797
&e2e.WebhookTestUpdater{WireWebhook: true},
98-
&templates.MainUpdater{WireWebhook: true, IsLegacyPath: s.isLegacy},
98+
&cmd.MainUpdater{WireWebhook: true, IsLegacyPath: s.isLegacy},
9999
&webhooks.WebhookTest{Force: s.force, IsLegacyPath: s.isLegacy},
100100
); err != nil {
101101
return err

0 commit comments

Comments
 (0)