Skip to content
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

update kpt alpha rpkg command help docs #3649

Merged
merged 1 commit into from
Nov 3, 2022
Merged

update kpt alpha rpkg command help docs #3649

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion commands/alpha/rpkg/clone/command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ func newRunner(ctx context.Context, rcg *genericclioptions.ConfigFlags) *runner
c.Flags().StringVar(&r.directory, "directory", "", "Directory within the repository where the upstream package is located.")
c.Flags().StringVar(&r.ref, "ref", "", "Branch in the repository where the upstream package is located.")
c.Flags().StringVar(&r.repository, "repository", "", "Repository to which package will be cloned (downstream repository).")
c.Flags().StringVar(&r.workspace, "workspace", "v1", "WorkspaceName of the downstream package.")
c.Flags().StringVar(&r.workspace, "workspace", "v1", "Workspace name of the downstream package.")

return r
}
Expand Down
2 changes: 1 addition & 1 deletion commands/alpha/rpkg/copy/command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ func newRunner(ctx context.Context, rcg *genericclioptions.ConfigFlags) *runner
RunE: r.runE,
Hidden: porch.HidePorchCommands,
}
r.Command.Flags().StringVar(&r.workspace, "workspace", "", "WorkspaceName of the copy of the package.")
r.Command.Flags().StringVar(&r.workspace, "workspace", "", "Workspace name of the copy of the package.")
return r
}

Expand Down
2 changes: 1 addition & 1 deletion commands/alpha/rpkg/init/command.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ func newRunner(ctx context.Context, rcg *genericclioptions.ConfigFlags) *runner
c.Flags().StringSliceVar(&r.Keywords, "keywords", []string{}, "list of keywords for the package.")
c.Flags().StringVar(&r.Site, "site", "", "link to page with information about the package.")
c.Flags().StringVar(&r.repository, "repository", "", "Repository to which package will be cloned (downstream repository).")
c.Flags().StringVar(&r.workspace, "workspace", "", "WorkspaceName of the downstream package.")
c.Flags().StringVar(&r.workspace, "workspace", "", "Workspace name of the downstream package.")

return r
}
Expand Down
24 changes: 11 additions & 13 deletions internal/docs/generated/rpkgdocs/docs.go
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions site/reference/cli/alpha/rpkg/clone/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@ TARGET_PACKAGE_NAME:
Repository to which package revision will be cloned
(downstream repository).

--revision
Revision for the new package.
--workspace
Workspace for the new package. The default value is v1.

--strategy
Update strategy that should be used when updating the new
Expand Down
10 changes: 4 additions & 6 deletions site/reference/cli/alpha/rpkg/copy/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ description: >

`copy` creates a new package revision from an existing one. The new
revision will be identical to the existing one but with a different
revision.
workspace.

### Synopsis

Expand All @@ -33,10 +33,8 @@ SOURCE_PACKAGE_REV_NAME:
#### Flags

```
--revision
Revision for the new package. If this is not specified, the default
revision will be `latest + 1`. The default can only be used if the
latest package revision is of the format `^v[0-9]+$`.
--workspace
Workspace for the new package revision.
```

<!--mdtogo-->
Expand All @@ -47,7 +45,7 @@ SOURCE_PACKAGE_REV_NAME:

```shell
# create a new package from package blueprint-b47eadc99f3c525571d3834cc61b974453bc6be2
$ kpt alpha rpkg copy blueprint-b47eadc99f3c525571d3834cc61b974453bc6be2 --revision=v10 --namespace=default
$ kpt alpha rpkg copy blueprint-b47eadc99f3c525571d3834cc61b974453bc6be2 --workspace=v10 --namespace=default
```

<!--mdtogo-->
12 changes: 6 additions & 6 deletions site/reference/cli/alpha/rpkg/init/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ PACKAGE_NAME:
--repository
Repository in which the new package will be created.

--revision
Revision of the new package. The default value if v1.
--workspace
Workspace of the new package.

--description
short description of the package
Short description of the package

--keywords
list of keywords for the package
List of keywords for the package

--site
link to page with information about the package
Link to page with information about the package
```

<!--mdtogo-->
Expand All @@ -55,7 +55,7 @@ PACKAGE_NAME:

```shell
# create a new package named foo in the repository blueprint.
$ kpt alpha rpkg init foo --namespace=default --repository=blueprint
$ kpt alpha rpkg init foo --namespace=default --repository=blueprint --workspace=v1
```

<!--mdtogo-->