Skip to content

Add repository option to crossplane project init #105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bobh66 wants to merge 4 commits into
base: main
Choose a base branch
from
+20 −5
Open

Add repository option to crossplane project init #105

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
18ca466
Add repository option to project init.
bobh66 Jun 12, 2026
92b63fa
Address review comments, revert directory name changes.
bobh66 Jun 12, 2026
4675ae8
Reject whitespace as repository name
bobh66 Jun 12, 2026
81a8e27
Refactor to provide --registry and --repository flags
bobh66 Jun 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions cmd/crossplane/project/init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ import (
"path/filepath"
"strings"

"github.com/google/go-containerregistry/pkg/name"
"k8s.io/apimachinery/pkg/util/validation"

"github.com/crossplane/crossplane-runtime/v2/pkg/errors"
Expand All @@ -38,8 +39,10 @@ const projectFileName = "crossplane-project.yaml"

// initCmd initializes a new project.
type initCmd struct {
Name string `arg:"" help:"The name of the new project."`
Directory string `help:"Directory to initialize. Defaults to project name." short:"d" type:"path"`
Name string `arg:"" help:"The name of the new project."`
Directory string `help:"Directory to initialize. Defaults to project name." short:"d" type:"path"`
Registry string `default:"example.com/my-org" help:"Override the registry in the project file." optional:"" short:"r"`
Repository string `help:"Override the repository name in the project file. Defaults to the project name." optional:""`
}

func (c *initCmd) Help() string {
Expand All @@ -55,12 +58,24 @@ func (c *initCmd) Run(sp terminal.SpinnerPrinter) error {
if c.Directory == "" {
c.Directory = c.Name
}

if strings.TrimSpace(c.Repository) == "" {
c.Repository = c.Name
}
Comment on lines +61 to +63

@coderabbitai coderabbitai Bot Jun 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Normalize Repository after trimming, before fallback and validation.

Right now TrimSpace is only used for the emptiness check, but Line 74 still consumes the untrimmed value. Could we persist the trimmed value so accidental leading/trailing spaces don’t cause avoidable parse failures?

Suggested patch 
-	if strings.TrimSpace(c.Repository) == "" {
+	c.Repository = strings.TrimSpace(c.Repository)
+	if c.Repository == "" {
 		c.Repository = c.Name
 	}
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@cmd/crossplane/project/init.go` around lines 61 - 63, In the Repository field
initialization block, the TrimSpace function is only used for the emptiness
check, but the untrimmed value is still assigned to c.Repository when empty.
Persist the trimmed value by assigning the result of
strings.TrimSpace(c.Repository) back to c.Repository before the fallback check,
so that any subsequent validation or usage of the Repository field at line 74 or
elsewhere operates on the normalized value without accidental leading or
trailing whitespace.

// Check if the target directory is suitable.
if err := c.checkTargetDirectory(); err != nil {
return err
}

rp := strings.TrimRight(strings.TrimSpace(c.Registry), "/")
if rp == "" {
return errors.New("registry cannot be empty; set --registryPath to an OCI registry prefix like 'xpkg.crossplane.io/my-org'")
}
Comment on lines +70 to +72

@coderabbitai coderabbitai Bot Jun 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Use the actual flag name in the empty-registry error message.

Line 71 points users to --registryPath, but the command defines --registry (Line 44). Could we update this so users can recover immediately?

Suggested patch 
-		return errors.New("registry cannot be empty; set --registryPath to an OCI registry prefix like 'xpkg.crossplane.io/my-org'")
+		return errors.New("registry cannot be empty; set --registry to an OCI repository prefix like 'xpkg.crossplane.io/my-org'")

As per coding guidelines, CLI errors in cmd/** should provide actionable user guidance.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@cmd/crossplane/project/init.go` around lines 70 - 72, The error message
returned when the registry path is empty references the incorrect flag name. In
the if block that checks if rp == "", update the error message to reference the
actual flag name `--registry` instead of `--registryPath` to match the flag
definition on line 44 and provide users with accurate guidance for fixing the
issue.

Source: Coding guidelines


r, err := name.NewRepository(rp + "/" + c.Repository)
if err != nil {
return errors.Wrapf(err, "cannot build function reference from repository \"%s/%s\"", rp, c.Repository)
}
Comment on lines +74 to +77

@coderabbitai coderabbitai Bot Jun 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟠 Major | ⚡ Quick win

Replace internal “function reference” wording with project init context.

The wrapped message says “cannot build function reference…”, which is confusing in this command path. Please use user-facing wording tied to invalid --registry/--repository input.

Suggested patch 
-		return errors.Wrapf(err, "cannot build function reference from repository \"%s/%s\"", rp, c.Repository)
+		return errors.Wrapf(err, "invalid repository value %q from --registry/--repository", rp+"/"+c.Repository)

Based on learnings, concise error strings are preferred when they clearly state the issue; as per coding guidelines for cmd/**, error text should remain user-facing and actionable.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@cmd/crossplane/project/init.go` around lines 74 - 77, The error message in
the repository creation block uses internal wording "cannot build function
reference" which is confusing in the project init command context. Replace this
error message with user-facing wording that clearly indicates the problem is
with invalid registry or repository parameters provided via the --registry and
--repository command flags. Keep the same error wrapping structure but update
the message text to be more actionable and appropriate for the project init
command path.

Sources: Coding guidelines, Learnings


return sp.WrapWithSuccessSpinner("Initializing project", func() error {
if err := os.MkdirAll(c.Directory, 0o750); err != nil {
return errors.Wrapf(err, "failed to create directory %s", c.Directory)
Expand All @@ -73,8 +88,8 @@ kind: Project
metadata:
name: %s
spec:
repository: example.com/my-org/%s
`, c.Name, c.Name)
repository: %s
`, c.Name, r.String())

if err := os.WriteFile(projFile, []byte(content), 0o600); err != nil {
return errors.Wrapf(err, "failed to write %s", projectFileName)
Expand Down
Loading