docs: add/update CLI plugin docs #1539
Conversation
k8s-ci-robot
added
cncf-cla: yes
estroz
force-pushed
the
docs/versioning-updates
branch
from
e2ffcf8
to
fb9bcb6
Compare
CONTRIBUTING.md
Outdated
| @@ -133,3 +152,5 @@ KubeBuilder and the related repositories. See | |||
|
|
|||
| Participation in the Kubernetes community is governed by the [Kubernetes Code of Conduct](code-of-conduct.md). | |||
|
|
|||
| [releases]:ttps://github.com/kubernetes-sigs/kubebuilder/releases | |||
| [plugins-design-versioning]:design/extensible-cli-and-scaffolding-plugins-phase-1.md | |||
estroz
force-pushed
the
docs/versioning-updates
branch
from
fb9bcb6
to
a975a1f
Compare
estroz
force-pushed
the
docs/versioning-updates
branch
from
6b43008
to
997bbd8
Compare
estroz
changed the title
estroz
force-pushed
the
docs/versioning-updates
branch
2 times, most recently
from
3579158
to
dae4ef5
Compare
estroz
force-pushed
the
docs/versioning-updates
branch
from
dae4ef5
to
5861d79
Compare
| | PROJECT version | `v1`,`v2`,`v3` | As of the introduction of [Extensible CLI and Scaffolding Plugins](https://github.com/kubernetes-sigs/kubebuilder/blob/master/designs/extensible-cli-and-scaffolding-plugins-phase-1.md), PROJECT version represents the layout of PROJECT file itself. For `v1` and `v2` projects, there's extra meaning -- see below. | | ||
| | Release version | `v2.2.0`, `v2.3.0`, `v2.3.1` | Tagged versions of the KubeBuilder project, representing changes to the source code in this repository. See the [releases](https://github.com/kubernetes-sigs/kubebuilder/releases) page. | | ||
| | Plugin Versions | `go.kubebuilder.io/v2.0.0` | Represents the version of an individual plugin, as well as the corresponding scaffolding that it generates. | | ||
| | KubeBuilder version | `v2.2.0`, `v2.3.0`, `v2.3.1` | Tagged versions of the KubeBuilder project, representing changes to the source code in this repository. See the [releases][kb-releases] page for binary releases. | |
There was a problem hiding this comment.
/hold
Until we are able to update it related to the latest changes.
k8s-ci-robot
added
the
do-not-merge/hold
|
@camilamacedo86 @DirectXMan12 these docs changes reflect the most recent plugin spec changes and should be ok to merge. |
on general development and versioning. docs/book/src/reference/cli-plugins.md: document current CLI plugin details here
estroz
force-pushed
the
docs/versioning-updates
branch
from
5861d79
to
4ec95b8
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: estroz The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
k8s-ci-robot
added
the
approved
|
/test pull-kubebuilder-e2e-k8s-1-17-0 |
|
HI @estroz this content was moved to VERSIONING.md. Could you please update your PR for we are able to get it merged? |
|
@estroz: PR needs rebase. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
k8s-ci-robot
added
the
needs-rebase
|
Hi @estroz, Since it is open for too long without interaction, in order to us be able to close this issue #1519 I pushed your changes in the VERSIONING.md doc which is the place where it is now via the PR: #1769. Would be very nice to get your help to review on that. In this way, I hope that is fine we close this one. However, feel free to re-open if you see that is required. |
|
/reopen |
|
@estroz: Failed to re-open PR: state cannot be changed. The docs/versioning-updates branch was force-pushed or recreated. In response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
Plugin versions do not need to contain a patch version number, since patch-like changes should not require the user to change their config's layout value. This commit rewrites and adds some documentation on general plugin development and versioning.
See #1519 (comment) for details.
Will follow up with patch version removal once #1536 is merged, which will allow both patched and non-patched version (
v2.0.0vsv2.0) resolution without a breaking change./cc @camilamacedo86 @DirectXMan12 @joelanford