Skip to content

update OWNERS.md and add release guide in README.md #22

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
merged 2 commits into from
Feb 3, 2021
+35 −6
Merged

update OWNERS.md and add release guide in README.md #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8cd51d9
update OWNERS file
neolit123 Jan 28, 2021
f748689
README.md: add section about creating releases
neolit123 Jan 28, 2021
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
20 changes: 14 additions & 6 deletions OWNERS
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
# See the OWNERS docs at https://go.k8s.io/owners

approvers:
- luxas
- timothysc
- fabriziopandini
- neolit123
- rosti
- ereslibre
- fabriziopandini
- neolit123
- SataQiu
reviewers:
- KentaTada
- odinuge
emeritus_approvers:
- luxas
- timothysc
- rosti
- ereslibre
labels:
- sig/cluster-lifecycle
- sig/node
21 changes: 21 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,27 @@

A set of system-oriented validators for kubeadm preflight checks.

## Creating releases

To prepare a release of this library please follow this guide:
- The main branch should always contain WIP commits planned for the upcoming release.
- Always create a new branch for MAJOR and MINOR releases. This allows backporting changes.
- Release branch names should be in the format `release-MAJOR.MINOR` (without a `v` prefix).
- Only non-breaking bug fixes can be done in a PATCH release.
- New features must not be added in PATCH releases.
- Breaking changes must be added in a MAJOR release.
- Pushing releases requires write access. To obtain that you must be part of
the [`system-validator-maintainers` team](http://git.k8s.io/org/config/kubernetes/sig-cluster-lifecycle/teams.yaml).

For vendoring the new release in kubernetes/kubernetes you can use its `pin-dependency.sh` script.

Example:
```bash
./hack/pin-dependency.sh k8s.io/system-validators <NEW-TAG>
```

And then PR the changes.

## Community, discussion, contribution, and support

Learn how to engage with the Kubernetes community on the [community page](http://kubernetes.io/community/).
Expand Down