Add mage for CI checks

Signed-off-by: jose.vazquez <[email protected]>

Author: josvazg

.github/workflows/crd2go.yml

@@ -54,11 +54,9 @@ jobs:
 
     - name: gci
       working-directory: ./tools/crd2go
-      run: |
-        echo "Did you run gofmt-gci?"
-        devbox run -- 'gci write --skip-generated -s standard -s default -s localmodule . && git diff-index --name-only HEAD && git diff-index --quiet HEAD --'
+      run: devbox run -- 'mage gci'
 
-  licenses:
+  addlicense:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v5
@@ -73,5 +71,4 @@ jobs:
 
     - name: Check license headers
       working-directory: ./tools/crd2go
-      run: |
-        devbox run -- 'addlicense -check -l apache -c "MongoDB Inc" -ignore "**/*.md" -ignore "**/*.yaml" -ignore "**/*.yml" -ignore "**/*.nix" -ignore ".devbox/**" .'
+      run: devbox run -- 'mage addlicense'

tools/crd2go/devbox.json

@@ -8,7 +8,8 @@
     "gh@latest",
     "gci@latest",
     "golangci-lint@latest",
-    "addlicense@latest"
+    "addlicense@latest",
+    "mage@latest",
   ],
   "shell": {
     "init_hook": [

tools/crd2go/devbox.lock

@@ -365,6 +365,54 @@
         }
       }
     },
+    "mage@latest": {
+      "last_modified": "2025-07-28T17:09:23Z",
+      "resolved": "github:NixOS/nixpkgs/648f70160c03151bc2121d179291337ad6bc564b#mage",
+      "source": "devbox-search",
+      "version": "1.15.0",
+      "systems": {
+        "aarch64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/ckcxxf6r85zndgx4rh3x3g570sysczf2-mage-1.15.0",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/ckcxxf6r85zndgx4rh3x3g570sysczf2-mage-1.15.0"
+        },
+        "aarch64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/1xln1pdk907lxm25dpdvx1xmp1rh43pd-mage-1.15.0",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/1xln1pdk907lxm25dpdvx1xmp1rh43pd-mage-1.15.0"
+        },
+        "x86_64-darwin": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/gwwj202lbp3smjdmnff18xr4fm439sn4-mage-1.15.0",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/gwwj202lbp3smjdmnff18xr4fm439sn4-mage-1.15.0"
+        },
+        "x86_64-linux": {
+          "outputs": [
+            {
+              "name": "out",
+              "path": "/nix/store/8jyy6nrmi505iczgi7d19gddqk00qqc9-mage-1.15.0",
+              "default": true
+            }
+          ],
+          "store_path": "/nix/store/8jyy6nrmi505iczgi7d19gddqk00qqc9-mage-1.15.0"
+        }
+      }
+    },
     "vscodium@latest": {
       "last_modified": "2025-04-07T13:23:10Z",
       "resolved": "github:NixOS/nixpkgs/b0b4b5f8f621bfe213b8b21694bab52ecfcbf30b#vscodium",

tools/crd2go/go.mod

@@ -4,6 +4,7 @@ go 1.24.3
 
 require (
 	github.com/dave/jennifer v1.7.1
+	github.com/magefile/mage v1.15.0
 	github.com/stretchr/testify v1.10.0
 	golang.org/x/text v0.24.0
 	gopkg.in/yaml.v3 v3.0.1

tools/crd2go/go.sum

@@ -29,6 +29,8 @@ github.com/kr/pretty v0.3.1 h1:flRD4NNwYAUpkphVc1HcthR4KEIFJ65n8Mw5qdRn3LE=
 github.com/kr/pretty v0.3.1/go.mod h1:hoEshYVHaxMs3cyo3Yncou5ZscifuDolrwPKZanG3xk=
 github.com/kr/text v0.2.0 h1:5Nx0Ya0ZqY2ygV366QzturHI13Jq95ApcVaJBhpS+AY=
 github.com/kr/text v0.2.0/go.mod h1:eLer722TekiGuMkidMxC/pM04lWEeraHUUmBw8l2grE=
+github.com/magefile/mage v1.15.0 h1:BvGheCMAsG3bWUDbZ8AyXXpCNwU9u5CB6sM+HNb9HYg=
+github.com/magefile/mage v1.15.0/go.mod h1:z5UZb/iS3GoOSn0JgWuiw7dxlurVYTu+/jHXqQg881A=
 github.com/modern-go/concurrent v0.0.0-20180228061459-e0a39a4cb421/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=
 github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd h1:TRLaZ9cD/w8PVh93nsPXa1VrQ6jlwL5oN8l14QlcNfg=
 github.com/modern-go/concurrent v0.0.0-20180306012644-bacd9c7ef1dd/go.mod h1:6dJC0mAP4ikYIbvyc7fijjWJddQyLn8Ig3JB5CqoB9Q=

tools/crd2go/magefile.go

@@ -0,0 +1,75 @@
+// Copyright 2025 MongoDB Inc
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+//
+
+//go:build mage
+
+package main
+
+import (
+	"fmt"
+
+	"github.com/magefile/mage/mg"
+	"github.com/magefile/mage/sh"
+)
+
+// CI runs all linting and validation checks.
+func CI() {
+	mg.SerialDeps(Addlicense, GCI)
+}
+
+// Addlicense runs the addlicense check to ensure source files have license headers.
+func Addlicense() error {
+	fmt.Println("Running license header check...")
+
+	// sh.RunV runs the command verbosely (streaming output)
+	// and returns an error if the command fails.
+	return sh.RunV("addlicense",
+		"-check",
+		"-l", "apache",
+		"-c", "MongoDB Inc",
+		"-ignore", "**/*.md",
+		"-ignore", "**/*.yaml",
+		"-ignore", "**/*.yml",
+		"-ignore", "**/*.nix",
+		"-ignore", ".devbox/**",
+		"-ignore", "magefile.go",
+		".",
+	)
+}
+
+// GCI runs gci to check that Go import orders are correct.
+func GCI() error {
+	fmt.Println("🧹 Formatting Go imports...")
+	if err := sh.RunV(
+		"gci", "write",
+		"--skip-generated",
+		"-s", "standard",
+		"-s", "default",
+		"-s", "localmodule",
+		".",
+	); err != nil {
+		return fmt.Errorf("gci write command failed: %w", err)
+	}
+
+	fmt.Println("🔍 Checking for changes...")
+	if err := sh.Run("git", "diff-index", "--quiet", "HEAD", "--"); err != nil {
+		fmt.Println("❗️ Go files were not correctly formatted. The following files have changes:")
+		sh.RunV("git", "diff-index", "--name-only", "HEAD")
+		return fmt.Errorf("please run 'mage gci' and commit the changes")
+	}
+
+	fmt.Println("✅ Go imports are correctly formatted.")
+	return nil
+}