Skip to content

Add a script and docs on specialized branch pointer moving. #9

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 1 commit into from
Jun 24, 2016
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ your favorite editor.
### Tools

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

Expand Down
172 changes: 172 additions & 0 deletions branchff
Original file line number Diff line number Diff line change
@@ -0,0 +1,172 @@
#!/bin/bash
#
# Copyright 2016 The Kubernetes Authors All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
# Set PROGram name
PROG=${0##*/}
########################################################################
#+
#+ NAME
#+ $PROG - Fast forward a branch to master via merge
#+
#+ SYNOPSIS
#+ $PROG [--nomock] <branch> [master object]
#+ $PROG [--helpshort|--usage|-?]
#+ $PROG [--help|-man]
#+
#+ DESCRIPTION
#+ $PROG fast forwards a K8s release branch to [master object] (defaults to
#+ HEAD and then prepares the branch as a K8s release branch:
#+ * build/versionize-docs.sh <branch>
#+ * Run hack/update-all.sh to ensure compliance of generated files
#+
#+
#+ OPTIONS
#+ [--nomock] - Actually push this upstream
#+ [--help | -man] - display man page for this script
#+ [--usage | -?] - display in-line usage
#+
#+ EXAMPLES
#+ $PROG release-1.3 - Resync master@HEAD onto release-1.3 branch
#+ $PROG release-1.3 39d0135e - Resync master@39d0135e onto release-1.3
#+ branch
#+
#+ FILES
#+
#+ SEE ALSO
#+ lib/common.sh - base function definitions
#+ lib/gitlib.sh - git function definitions
#+
#+ BUGS/TODO
#+
########################################################################
# If NO ARGUMENTS should return *usage*, uncomment the following line:
usage=${1:-yes}

source $(dirname $(readlink -ne $BASH_SOURCE))/lib/common.sh
source $TOOL_LIB_PATH/gitlib.sh

# Set positional args
RELEASE_BRANCH=${POSITIONAL_ARGV[0]}
MASTER_OBJECT=${POSITIONAL_ARGV[1]:-"origin/master"}

# Check branch format
[[ $RELEASE_BRANCH =~ $BRANCH_REGEX ]] || common::exit 1 "Invalid branch name!"

# Branch Exists
gitlib::branch_exists $RELEASE_BRANCH \
|| common::exit 1 "$RELEASE_BRANCH doesn't exist. Exiting..."

##############################################################################
# Initialize logs
##############################################################################
# Initialize and save up to 10 (rotated logs)
MYLOG=/tmp/$PROG.log
common::logfileinit $MYLOG 10
# BEGIN script
common::timestamp begin

###############################################################################
# MAIN
###############################################################################
BASEDIR="/usr/local/google/$USER"
# WORK/BUILD area
WORKDIR=$BASEDIR/$PROG-$RELEASE_BRANCH
# TREE_ROOT is working branch/tree
TREE_ROOT=$WORKDIR/kubernetes
# The real deal?
if ((FLAGS_nomock)); then
DRYRUN_FLAG=""
else
DRYRUN_FLAG=" --dry-run"
fi

logecho
logecho "Follow along in detail: tailf $MYLOG"

##############################################################################
common::stepheader "SESSION DETAILS"
##############################################################################
logecho "NOTE: This is a${DRYRUN_FLAG:-"n ACTUAL"} run!"

##############################################################################
common::stepheader "SYNC A WORKING REPO"
##############################################################################
if [[ -d $WORKDIR ]]; then
common::askyorn "$WORKDIR exists. Delete" || common::exit 1 "Exiting..."
logrun rm -rf $WORKDIR || common::exit 1 "Exiting..."
fi

logrun mkdir -p $WORKDIR
gitlib::sync_repo $K8S_GITHUB_URL $TREE_ROOT || common::exit 1 "Exiting..."
logrun cd $TREE_ROOT

##############################################################################
common::stepheader "CHECK GIT PUSH ACCESS"
##############################################################################
# TODO: capture state of access without forcing us into a prompt I have to
# expose.
logecho -n "Checking git push access (verbosely to accept password if needed)"
logrun -v git push -q --dry-run $K8S_GITHUB_URL || common::exit 1 "Exiting..."

##############################################################################
common::stepheader "CHECK OUT BRANCH"
##############################################################################
logecho -n "Checking out $RELEASE_BRANCH: "
logrun -s git checkout -b $RELEASE_BRANCH origin/$RELEASE_BRANCH \
|| common::exit 1 "Exiting..."

##############################################################################
common::stepheader "MERGE AND UPDATE"
##############################################################################
logecho -n "Merging $MASTER_OBJECT into $RELEASE_BRANCH branch: "
logrun -s git merge -X ours $MASTER_OBJECT

# TODO: This is actually broken until #27992 lands
logecho -n "update-all.sh: "
logrun -s hack/update-all.sh

# Redo the branching activities
logecho -n "Check/rerun versionize-docs.sh again: "
logrun -s build/versionize-docs.sh $RELEASE_BRANCH

if [[ -n "$(git status -s)" ]]; then
logecho -n "Commit changes: "
logrun git add -A
logrun -s git commit -am "versionize-docs.sh and update-all.sh." \
|| common::exit 1 "Exiting..."
fi

##############################################################################
common::stepheader "PUSH UPSTREAM"
##############################################################################
logecho "Go look around in $WORKDIR to make sure things look ok:"
logecho "# Any files left uncommitted?"
logecho "* git status -s"
logecho "# What does the commit look like?"
logecho "* git show"
logecho

if common::askyorn -e "OK to push now"; then
# Finally push it upstream
logecho -n "Pushing$DRYRUN_FLAG $RELEASE_BRANCH branch upstream: "
logrun -s git push $DRYRUN_FLAG origin $RELEASE_BRANCH:$RELEASE_BRANCH
fi

logecho
logecho "$WORKDIR left intact for reviewing"

# END script
common::timestamp end
17 changes: 17 additions & 0 deletions docs/branching.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Branching

Some caveats to branching.

We branch earlier than we really should as a way to encourage stabilization
on the master branch.

During that time only milestone-specific changes are allowed into the
master and when things are stable (enough) we effectively sync the
release branch to the HEAD of the master branch:

```
$ branchff release-1.3

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do the other tools here also lack a .sh extension?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Only libraries get .sh extensions.

```

Once that happens we then open up master to milestone+1 changes
and move to the 2 phase [cherry-pick model](https://github.com/kubernetes/kubernetes/blob/master/docs/devel/cherry-picks.md)
20 changes: 15 additions & 5 deletions docs/releasing.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,20 @@
# Kubernetes Releases

TBD
This repo contains the tooling and documentation for the release of
the core Kubernetes project.

In the future it is expected that the functionality will expand and be
generalized to support release infrastrcture for all of the kubernetes
sub-projects as well.

The tooling and doc here is expected to change often as requirements
change and the project(s) evolve.

The doc and tooling in this repo is NOT designed to address the planning,
coordination of releases. For more info on feature and release planning see:
* [Kubernetes Community Wiki](https://github.com/kubernetes/community/wiki)
* [Kubernetes Feature Tracking](https://github.com/kubernetes/features)


## Types of Releases

Expand All @@ -10,7 +24,3 @@ TBD
* Official releases (`vX.Y.Z`) are cut from their respective release branch,
`release-X.Y`.
* New release series are also cut directly from `master`.

## More

TBD