Skip to content

🏃 PR Templates #224

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.

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
Nov 27, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/breaking_change.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Breaking change (X)
about: A breaking change to the API surface or expected behavior of this project.

---

<!-- please add a :warning: (`:warning:`) to the title of this PR, and delete this line and similar ones -->

<!-- What does this do, and why do we need it? -->

<!-- Why does this have to be a breaking change (what else did you consider)? -->
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/bug_fix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
name: Bug fix (Z)
about: A bug fix that doesn't otherwise change API surface

---

<!-- please add a :bug: (`:bug:`) to the title of this PR, and delete this line and similar ones -->

<!-- What does this do, and why do we need it? -->

<!-- What issue does this fix (e.g. Fixes #XYZ) -->
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/compat_feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Backwards-compatible feature (Y)
about: A new feature that adds to the API surface or behavior, but doesn't break backwards compatibility

---

<!-- please add a :sparkles: (`:sparkles:`) to the title of this PR, and delete this line and similar ones -->

<!-- What does this do, and why do we need it? -->
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/docs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Documentation
about: A change to the documentation of this repository

---

<!-- please add a :book: (`:book:`) to the title of this PR, and delete this line and similar ones -->

<!-- What docs does this change, and why? -->
9 changes: 9 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
name: Tests/Infra/Other
about: A change to the tests in this repo, the utilities scripts, or some other piece of infrastructure tooling

---

<!-- please add a :running: (`:running:`) to the title of this PR, and delete this line and similar ones -->

<!-- What does this do, and why do we need it? -->
18 changes: 10 additions & 8 deletions VERSIONING.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,10 @@ to match the PR. For instance, if you have a bugfix in with a breaking
change, it's generally encouraged to submit the bugfix separately, but if
you must put them in one PR, mark the commit separately.

*Commits marked separately will be treated similiarly to a distinct PR by
the cherrypick scripts*. Therefore, only use them if you want the given
commit to be considered separately.

### Commands and Workflow

controller-runtime follows the standard Kubernetes workflow: any PR needs
Expand All @@ -126,17 +130,15 @@ will evaluate when to do a major release as it comes up.

### Exact Steps

1. Generate release notes using the release note tooling (***TODO***)

2. Add a release for controller-runtime on GitHub, using those release
notes
1. (*if doing a minor or patch release*) Update the release-X branch with
the latest set of changes using the cherrypick tooling (***TODO***)

3. Add a release for controller-tools on GitHub (folowing a similar
process for controller-tools release notes).
2. Generate release notes using the release note tooling (***TODO***)

4. Publish associated binaries and release tarballs (***TODO***)
3. Add a release for controller-runtime on GitHub, using those release
notes, with a title of `vX.Y.Z`.

5. Announce the release in `#kubebuilder` on Slack with a pinned message.
4. Announce the release in `#kubebuilder` on Slack with a pinned message.

### Breaking Changes

Expand Down