Add versioning and releases to README #967
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
k8s-ci-robot
added
do-not-merge/work-in-progress
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: vincepri 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
ncdc
reviewed
May 30, 2019
vincepri
force-pushed
the
versioning-releases
branch
from
6177e73 to
0d19636
Compare
vincepri
changed the title
k8s-ci-robot
removed
the
do-not-merge/work-in-progress
|
/hold Putting on hold until next week for lazy consensus. |
k8s-ci-robot
added
the
do-not-merge/hold
dhellmann
suggested changes
May 30, 2019
chuckha
reviewed
May 30, 2019
vincepri
force-pushed
the
versioning-releases
branch
from
0d19636 to
ca3a0cd
Compare
|
/test pull-cluster-api-integration |
astrieanna
reviewed
Jun 4, 2019
astrieanna
reviewed
Jun 4, 2019
| @@ -66,6 +66,14 @@ Following are the implementations managed by third-parties adopting the standard | |||
| * Machine API Operator, https://github.com/openshift/machine-api-operator/tree/master | |||
| * Machine-controller-manager, https://github.com/gardener/machine-controller-manager/tree/cluster-api | |||
|
|
|||
| ## Versioning, Maintenance, and Compatibility | |||
|
|
|||
| - We follow [Semantic Versioning (semver)](https://semver.org/). | |||
There was a problem hiding this comment.
In order to make it clearer what qualifies as a "backwards incompatible change" that would trigger a major version bump, would it makes sense to add some examples here?
- You can't run the new controllers in some existing management clusters.
- You can't manage some existing clusters deployed by the prior version of Cluster API.
- Your automation scripts or yaml for interacting with Cluster API will no longer work.
There was a problem hiding this comment.
Given that the readme was meant to provide only a short summary, would you like to take as an action item to follow-up with a more in depth versioning document? This is where I took inspiration for these points https://github.com/kubernetes-sigs/controller-runtime/blob/master/VERSIONING.md
Signed-off-by: Vince Prignano <[email protected]>
vincepri
force-pushed
the
versioning-releases
branch
from
ca3a0cd to
b882415
Compare
|
/test pull-cluster-api-test |
|
/lgtm I think it is outside of the scope of this PR, but we should also highlight our use of the k8s API versioning policy, and the rough timelines we envision for the next couple alpha API releases... Unless the implicit intent is that we will release new API versions as necessary while tracking k8s binary releases. That probably makes more sense. |
k8s-ci-robot
added
the
lgtm
dhellmann
approved these changes
Jun 5, 2019
|
@dhellmann: changing LGTM is restricted to assignees, and only kubernetes-sigs/cluster-api repo collaborators may be assigned issues. 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. |
|
/hold cancel |
k8s-ci-robot
removed
the
do-not-merge/hold
detiber
pushed a commit
to detiber/cluster-api
that referenced
this pull request
Jun 6, 2019
Signed-off-by: Vince Prignano <[email protected]>
detiber
pushed a commit
to detiber/cluster-api
that referenced
this pull request
Jun 6, 2019
Signed-off-by: Vince Prignano <[email protected]>
k8s-ci-robot
pushed a commit
that referenced
this pull request
Jun 7, 2019
* Adding steps for how to use existing cluster as bootstrap cluster. (#877) * Add proposals template (#879) Signed-off-by: Vince Prignano <[email protected]> * Clarify how to use kuebconfig. (#869) * Add discuss link to README (#885) Signed-off-by: Vince Prignano <[email protected]> * Fix a broken link to Cluster API KEP (#900) * Add Cluster API project scope and objectives (#882) Signed-off-by: Vince Prignano <[email protected]> * Fix API group name written in kubebuilder's annotation comments (#883) * Update github org for the baremetal provider. (#911) The github org was renamed, so use the new URL for the location of the bare metal cluster-api provider. * Add Talos to list of providers (#915) * Add reference use cases for Cluster API (#903) Signed-off-by: Vince Prignano <[email protected]> * Add missing bullet point to staging-use-cases.md (#920) * Added IBM Cloud to Cluster API README. (#928) * Update documentation links to published content (#927) * Add Cluster API logos from CNCF (#916) * Adding Reference Use Cases to README. (#931) * Updating release docs for branching approach now that we are 0.x (#862) I think the previous approach was for pre-versioned branches, but now we probably want to start maintaining release branches - even if in practice we would cut 0.2.0 instead of 0.1.1 * Used doctoc generated toc. (#932) * Update to go 1.12.5 (#937) * Attempt to fix integration tests (#942) - Use specific versions of kind and kustomize instead of installing with `go get` - Update golang version for example provider * Update README.md (#941) * Add shortnames for crds. (#943) * Fix machine object pivoting to the target cluster (#944) * [docs] Update RBAC annotations for example provider (#947) * Remove workstreams from scope and objectives (#948) Signed-off-by: Vince Prignano <[email protected]> * Added ibm cloud to architecture diagram. (#946) * Added comment about cluster API vs cloud providers to readme (#954) * Quit MachineSet reconcile early if DeletionTimestamp is set (#956) Signed-off-by: Vince Prignano <[email protected]> * Cleanup controllers (#958) Signed-off-by: Vince Prignano <[email protected]> * updates Google Cloud branding to mach other usages (#973) * Cannot retrieve machine name (#960) Signed-off-by: clyang82 <[email protected]> * Allow to use foregroundDeletion for MachineDeployments and MachineSets (#953) * Rename controllers test files (#968) Signed-off-by: Vince Prignano <[email protected]> * make cluster-api-manager container run with a non-root user (#955) * Update Gitbook release process (#659) * Remove mermaid module because it is currently unused and does not always install cleanly. * Introduce npm-shrinkwrap so that npm installations are reproducable. * Update gitbook release documentation. * Clarify verification instructions. * Update GitBook. * Remove rendered Gitbook from repo in preparation for using firebase instead. * Install gitbook cli. * Update documentation for netlify. * Add Netlify configuration toml. * Update link to homepage so that it points to the book and not the GitHub repository. * Remove base from netlify.toml. The build script already accounts for the correct location... * Remove reference to no longer existent KEP. :( * Disable redirects until the cluster-api.sigs.k8s.io domain has been created. * Reenable netlify redirects now that the cluster-api.sigs.k8s.io domain exists. * Add versioning and releases to README (#967) Signed-off-by: Vince Prignano <[email protected]> * Add more log for cluster deletion failure (#978) * Update dependencies (#982) Signed-off-by: Vince Prignano <[email protected]>
6 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Vince Prignano [email protected]
What this PR does / why we need it:
This PR adds the release cadence and general versioning information for the project. These changes were discussed during the May 29th 2019 community meeting.
Which issue(s) this PR fixes (optional, in
fixes #<issue number>(, fixes #<issue_number>, ...)format, will close the issue(s) when PR gets merged):Fixes #290
Special notes for your reviewer:
Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.
Release note: