Skip to content

Commit

Permalink
docs: kpt alpha rpkg propose-delete (#3762)
Browse files Browse the repository at this point in the history
  • Loading branch information
natasha41575 authored Feb 6, 2023
1 parent 9dbfc60 commit f88dc78
Show file tree
Hide file tree
Showing 4 changed files with 66 additions and 4 deletions.
4 changes: 4 additions & 0 deletions commands/alpha/rpkg/proposedelete/command.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import (
"fmt"
"strings"

"github.com/GoogleContainerTools/kpt/internal/docs/generated/rpkgdocs"
"github.com/GoogleContainerTools/kpt/internal/errors"
"github.com/GoogleContainerTools/kpt/internal/util/porch"
"github.com/GoogleContainerTools/kpt/porch/api/porch/v1alpha1"
Expand All @@ -39,6 +40,9 @@ func newRunner(ctx context.Context, rcg *genericclioptions.ConfigFlags) *runner
c := &cobra.Command{
Use: "propose-delete PACKAGE",
Aliases: []string{"propose-del"},
Short: rpkgdocs.ProposeDeleteShort,
Long: rpkgdocs.ProposeDeleteShort + "\n" + rpkgdocs.ProposeDeleteLong,
Example: rpkgdocs.ProposeDeleteExamples,
SuggestFor: []string{},
PreRunE: r.preRunE,
RunE: r.runE,
Expand Down
17 changes: 16 additions & 1 deletion internal/docs/generated/rpkgdocs/docs.go

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

43 changes: 43 additions & 0 deletions site/reference/cli/alpha/rpkg/propose-delete/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: "`propose-delete`"
linkTitle: "propose-delete"
type: docs
description: >
Propose deletion of a published package revision.
---

<!--mdtogo:Short
Propose deletion of a published package revision.
-->

`propose-delete` proposes a published package revision for deletion, i.e.
changes its lifecycle from 'Published' to 'DeletionProposed'.

### Synopsis

<!--mdtogo:Long-->

```
kpt alpha rpkg propose-delete PACKAGE_REV_NAME... [flags]
```

#### Args

```
PACKAGE_REV_NAME...:
The name of one or more package revisions. If more than
one is provided, they must be space-separated.
```

<!--mdtogo-->

### Examples

<!--mdtogo:Examples-->

```shell
# Propose published package revision blueprint-e982b2196b35a4f5e81e92f49a430fe463aa9f1a for deletion.
$ kpt alpha rpkg propose-delete blueprint-e982b2196b35a4f5e81e92f49a430fe463aa9f1a --namespace=default
```

<!--mdtogo-->
6 changes: 3 additions & 3 deletions site/reference/cli/alpha/rpkg/reject/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ title: "`reject`"
linkTitle: "reject"
type: docs
description: >
Reject a proposal to publish a package revision.
Reject a proposal to publish or delete a package revision.
---

<!--mdtogo:Short
Reject a proposal to publish a package revision.
Reject a proposal to publish or delete a package revision.
-->

`reject` closes a proposal for publishing a package revision.
`reject` closes a proposal for publishing or deleting a package revision.

### Synopsis

Expand Down

0 comments on commit f88dc78

Please sign in to comment.