release.sh

#!/bin/bash

# Script to make a dated release of the WebRTC 1.0 spec.
#
# Prerequisites: You must have a remote called "origin" that points to the
# github repo. You must have local branches called "master" and "gh-pages".
#
# Run this script to create a release when work has been done on the "master"
# branch and it's ahead of your local "gh-pages" branch (as well as
# "origin/master" and "origin/gh-pages").
#
# How to use:
#
# 1. Prepare the release (previous release date before the new one)
#    $ ./release.sh 20140817 20140909 prepare
#
# 2. Browse to the webrtc-stats.html source file and press Ctrl+Alt+Shift+s
#    to show the respec save dialog. Click the "Save as HTML" option and save
#    the resulting document at the location proposed this script.
#
# 3. Continue the release (change last script argument)
#    $ ./release.sh 20140817 20140909 continue
#
# 4. Take a look at the repo with, e.g., "gitk --all". The branches gh-pages
#    and master should be at the top of the tree along with a new tag. The
#    remote branches should be lagging behind.
#
# 5. Push the new release to github. Do:
#    $ ./release.sh 20140817 20140909 fakepush
#    to test pushing without sending anything to the server. Then do:
#    $ ./release.sh 20140817 20140909 push
#
# 6. (Optional)
#    Print a release email (with links to releases and change log). You have
#    to mail it manually.
#    $ ./release.sh 20140817 20140909 email <your name>
#
# 7. Add a new "Changes since" section with <li></li> placeholder for
#    new changes to be listed.
#
# Done.
#
# If you made a release, pushed it to the github repo and notice that you missed
# something that requires extra commits to fix. Then, after you fixed the issue
# and pushed the fixes, run this script with the "retag" option to move the
# release tag to point to the new top of the tree. Example:
# $ ./release.sh 20140817 20140909 retag
#

# Source and repository settings
REPO_NAME="webrtc-stats"
SRC_NAME="webrtc-stats.html"
CONFIG_NAME="webrtc-stats.js"

PREV_DATE=$1
NEW_DATE=$2
STAGE=$3

USAGE="\n\nUsage: $0 <prev-date> <new-date> prepare | continue | fakepush | push | email <your-name> | retag  \n\
For example: $0 20140817 20140909 prepare"

DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
TAG_NAME="v$NEW_DATE"
ARCHIVED_SRC="$DIR/archives/$NEW_DATE/$SRC_NAME"
THIS_VERSION_LINK="https://w3c.github.io/$REPO_NAME/archives/$NEW_DATE/$SRC_NAME"

case $(uname) in
  *Darwin*)
    DARWIN=1
    ;;
esac

pushd $DIR > /dev/null

function quit {
  popd > /dev/null
  exit $1
}

function check {
  if [ $? != 0 ] ; then
    echo "* $1: Failed (!)"
    quit 1
  fi
  echo "* $1: Done"
}

function push {
  if [ ! -d $DIR/archives/$NEW_DATE ] ; then
    echo "Unable to find archives/$NEW_DATE"
    echo "Have you done the \"prepare\" and \"continue\" steps before \"push\"?"
    exit 1
  fi

  git push $1 origin master gh-pages $TAG_NAME
  check "Push branches and tag"
}

if [ $# -lt 3 ] ; then
  echo -e "Too few arguments. $USAGE"
  quit 1
fi

BRANCH=$(git symbolic-ref --short HEAD)
if [ $BRANCH != "master" ] ; then
  echo "You should be on the (local) master branch to do a release (you are on $BRANCH)"
  quit 1
fi

case $STAGE in
  prepare)
    echo "*** Prepare ***"

    if [ -n "$DARWIN" ] ; then
      sed -i "" "s/prevED:.*$/prevED: \"https:\/\/w3c.github.io\/$REPO_NAME\/archives\/$PREV_DATE\/$SRC_NAME\",/" $CONFIG_NAME
    else
      sed -i "s/prevED:.*$/prevED: \"https:\/\/w3c.github.io\/$REPO_NAME\/archives\/$PREV_DATE\/$SRC_NAME\",/" $CONFIG_NAME
    fi
    check "Update prevED field in respec config"

    mkdir -p archives/$NEW_DATE
    check "Create new archive dir"

    echo "Do the Ctrl+Alt+Shift+s thing in Rspec.js and save the generated version as: "
    echo "$DIR/archives/$NEW_DATE/$SRC_NAME"
    echo -e "\nWhen the generated version is saved, run:"
    echo "$0 $PREV_DATE $NEW_DATE continue"
    ;;

  continue)
    echo "*** Continue ***"

    if [ ! -f $ARCHIVED_SRC ] ; then
      echo "Unable to find archives/$NEW_DATE/$SRC_NAME"
      echo "Please refer to the previous step (prepare)."
      exit 1
    fi

    if [ -n "$DARWIN" ] ; then
      sed -i "" "s|<dd><a class=\"u-url\" href=.*$|<dd><a class=\"u-url\" href=\"$THIS_VERSION_LINK\">$THIS_VERSION_LINK</a></dd>|" $ARCHIVED_SRC
    else
      sed -i "s|<dd><a class=\"u-url\" href=.*$|<dd><a class=\"u-url\" href=\"$THIS_VERSION_LINK\">$THIS_VERSION_LINK</a></dd>|" $ARCHIVED_SRC
    fi
    check "Update \"This version\" field in generated source"

    if [ -d images ]; then
      cp -r images archives/$NEW_DATE/
      check "Copy image resources"
    fi

    git add archives/$NEW_DATE
    check "Add new archive directory"

    ln -s -f archives/$NEW_DATE/$SRC_NAME index.html
    check "Create index.html sym-link"

    git commit -am "Added dated version $TAG_NAME"
    check "Make commit"

    git tag -m "Editor's draft $NEW_DATE." $TAG_NAME
    check "Add tag"

    git rebase master gh-pages
    check "Rebase gh-pages on master"

    git checkout master
    check "Checkout master again (after rebase)"

    echo -e "\nPlease review the state of your repo. If everything looks OK, run:"
    echo "$0 $PREV_DATE $NEW_DATE fakepush"
    echo "to test pushing without actually sending anything to the server, or:"
    echo "$0 $PREV_DATE $NEW_DATE push"
    echo "to push for real."
    ;;

  fakepush)
    echo "*** Fakepush ***"
    push "--dry-run"
    ;;

  push)
    echo "*** Push ***"
    push
    ;;

  email)
    echo "*** Email ***"
    SINGLE_DAY=$(date -d $PREV_DATE '+%e' | tr -d " ") # remove padding spaces
    CHANGE_LOG_DATE=$(date -d $PREV_DATE "+%B $SINGLE_DAY, %Y")
    EDITOR_NAME=$4

    echo -e "Inspecting Change Log since $CHANGE_LOG_DATE\n"

    echo "============= Subject =============="
    echo "New $REPO_NAME Editor's draft (v$NEW_DATE)"
    echo "========== Start of email =========="
    echo "Hi"
    echo ""
    echo "A new dated version of the Editors' draft is available."
    echo ""
    echo "Dated version: https://w3c.github.io/$REPO_NAME/archives/$NEW_DATE/$SRC_NAME"
    echo "Living document: https://w3c.github.io/$REPO_NAME/"
    echo ""

    echo "Changes include:"
    sed -n "/Changes since $CHANGE_LOG_DATE/{:a;n;/Changes since/b;p;ba}" $SRC_NAME | sed "s/^ \+\|<ol>\|<\/ol>\|<li>\|<\/li>//g"

    echo "Please review and provide feedback."
    echo ""
    echo "$EDITOR_NAME (for the editors)"
    echo "=========== End of email ==========="
    echo ""
    ;;

  retag)
    echo "*** Retag ***"
    git tag -d $TAG_NAME
    check "Remove local tag"

    git push origin :refs/tags/$TAG_NAME
    check "Remove server tag"

    git tag -m "Editor's draft $NEW_DATE." $TAG_NAME
    check "Add new tag at master's position"

    git push origin $TAG_NAME
    check "Push new tag"
    ;;

  *)
    echo -e "Unknown option. $USAGE"
    quit 1
esac

echo "*** Done ***"

quit 0