Skip to content

Commit 08cc4e1

Browse files
committed
WIP: Add a docs/branching.md doc with info on specialized branch pointer moving.
Also clarify this repo further in docs/releasing.md. And fix some other related doc issues.
1 parent c460def commit 08cc4e1

File tree

3 files changed

+48
-2
lines changed

3 files changed

+48
-2
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ your favorite editor.
8282
### Tools
8383

8484
* [mailer](https://github.com/kubernetes/release/blob/master/mailer) : Generic mail interface (due to Google's deprecation of sendmail)
85-
* [find_green_job](https://github.com/kubernetes/release/blob/master/find_green_job) : Ask Jenkins for a good build to use
85+
* [find_green_build](https://github.com/kubernetes/release/blob/master/find_green_build) : Ask Jenkins for a good build to use
8686
* [script-template](https://github.com/kubernetes/release/blob/master/script-template) : Generate a script template in the kubernetes/release ecosystem
8787
* [relnotes](https://github.com/kubernetes/release/blob/master/relnotes) : Scrape github for release notes \(See below for more info\)
8888

docs/branching.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Branching
2+
3+
Some caveats to branching.
4+
5+
We usually branch early as a psychological placeholder to keep a cap on
6+
changes landing on master.
7+
8+
During that time only milestone-specific changes are allowed into the
9+
master and when things are stable (enough) we effectively move the
10+
release branch to the HEAD of the master branch:
11+
12+
```
13+
# checkout a local branch
14+
$ git checkout -b release-1.3 upstream/release-1.3
15+
# move the pointer to top of master branch
16+
$ git reset --hard upstream/master
17+
# Redo the branching activities
18+
$ #do anago::rev_version_base() again (and commit it)
19+
$ build/versionize-docs.sh v1.3.0-beta.0 (and commit)
20+
$ git tag -f v1.3.0-beta.0
21+
# Finally push it upstream (or whatever remote you are using)
22+
$ git push -f upstream release-1.3:release-1.3.
23+
```
24+
25+
** Like everything else, this should be scripted into a well documented,
26+
error-checked button (script) so it can just be logically handled by
27+
anyone with minimal inputs.
28+
29+
30+
31+
Once that happens we then open up master to milestone+1 changes
32+
and move to the 2 phase cherry-pick model:
33+

docs/releasing.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,19 @@
11
# Kubernetes Releases
22

3-
TBD
3+
This repo contains the tooling and documentation for the release of
4+
the core Kubernetes project.
5+
6+
In the future it is expected that the functionality will expand and be
7+
generalized to support release infrastrcture for all of the kubernetes
8+
sub-projects as well.
9+
10+
The tooling and doc here is expected to change often as requirements
11+
change and the project(s) evolve.
12+
13+
The doc and tooling in this repo is NOT designed to address the planning,
14+
coordination of releases. See ---insert goltermann and PM project
15+
planning docs/links here----.
16+
417

518
## Types of Releases
619

0 commit comments

Comments
 (0)