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

Merged
adamwg merged 5 commits into from
Jun 23, 2026
+20 −5
Merged

Add repository option to crossplane project init #105

Changes from 3 commits
Commits
Show all changes
5 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
d853516
Fix lint errors
bobh66 Jun 23, 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
13 changes: 9 additions & 4 deletions cmd/crossplane/project/init.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,9 @@ 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"`
Repository string `default:"example.com/my-org" help:"Override the repository in the project file." optional:"" short:"r"`
}

func (c *initCmd) Help() string {
Expand All @@ -61,6 +62,10 @@ func (c *initCmd) Run(sp terminal.SpinnerPrinter) error {
return err
}

repo := strings.TrimRight(strings.TrimSpace(c.Repository), "/")
if repo == "" {
return errors.New("repository cannot be empty; set --repository to an OCI repository prefix like 'xpkg.crossplane.io/my-org'")

@adamwg adamwg Jun 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Might be worth validating that repo is a valid, fully-qualified repository by calling name.NewRepository.

}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
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 +78,8 @@ kind: Project
metadata:
name: %s
spec:
repository: example.com/my-org/%s
`, c.Name, c.Name)
repository: %s/%s
`, c.Name, repo, c.Name)

@adamwg adamwg Jun 17, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

I'd prefer to just use repo when it's specified, rather than appending the project name. OCI defines two things: registries and repositories; the in-between of a partially-specified repository isn't really a concept.

@bobh66 bobh66 Jun 17, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Don't we really have three parts - the registry, the org and the repository? Maybe the option should be registryPath or similar to include both the registry and the org? I'd like to be able to default the repository name to the project name rather than have to specify it again in the registry path.

@adamwg adamwg Jun 18, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

The first component of the repository being an organization name is just a convention, not specified by OCI. That said, it is a very common convention - every public registry I can think of follows it (GHCR, Docker Hub, Upbound marketplace, etc.).

Agreed it's a nice UX to not require repeating the project name. I think making the argument --registry (not technically correct, but less surprising to append to it) or --repository-prefix would make sense. That would allow for a --repository flag to provide the full path as well, if users want the repository name to not match the project name.


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