Merge pull request github#359 from github/i18n-updates

I18n: Keeping translations updated

Author: bkeepers

docs/translations.md

@@ -14,6 +14,14 @@ If there's not, then today is your day to lead this effort! Here's how to start:
 
 ## Keeping a translation updated
 
-TODO
+Git is pretty good at tracking files that have changed. We'll try to make it as easy as possible for you to keep your translation up to date.
+
+Note: These directions assume the `origin` [remote](https://git-scm.com/docs/git-remote) is the translation fork. If you didn't originally clone the repository from the fork, you can update it with `git remote set-url origin https://github.com/[yourname]/opensource.guide.git`.
+
+Here is the recommended process:
+
+0. Run `$ script/sync-translation` to merge the latest changes from upstream and open a Pull Request on your fork.
+0. If files requiring translation have been modified, they will be added to a checklist in the Pull Request.
+0. Once all files have been updated, merge the pull request.
 
-should be easy to merge in changes from upstream without conflicts
+Run this script as often as you want to keep your translation up to date.

script/sync-translation

@@ -0,0 +1,61 @@
+#!/bin/sh
+#
+# Sync changes from upstream and open a pull request
+#
+#   Usage: script/sync-upstream [remote]
+#
+# TODO:
+# - [ ] handle merge conflicts with `git merge --continue`
+
+set -e
+
+which -s hub || (echo "This script requires the 'hub' command: http://hub.github.com/" && exit 1)
+
+# If there's not an upstream remote, set it.
+if ! git remote show | grep -q upstream; then
+  git remote add upstream https://github.com/github/opensource.guide.git
+fi
+
+REMOTE=${1:-"origin"}
+BASE="$REMOTE/gh-pages"
+# FIXME: switch to upstream/gh-pages before this is merged:
+# https://github.com/github/open-source-guide/pull/295
+HEAD="upstream/i18n"
+
+git fetch upstream
+git fetch $REMOTE
+
+BASE_SHA=$(git rev-parse $BASE)
+HEAD_SHA=$(git rev-parse $HEAD)
+BRANCH="sync-${HEAD_SHA:0:8}"
+
+TRANSLATABLE_FILES="
+  _articles
+  _data/locale/en-US.yml
+  _config
+"
+
+## Create a new branch and merge in the changes from upstream.
+echo "Creating branch $BRANCH based off $BASE"
+git checkout -B $BRANCH $BASE
+echo "Merging in latest changes from $HEAD"
+git merge -q --no-edit $HEAD
+git push $REMOTE $BRANCH
+
+CHANGED_FILES=$(git diff --name-only $BASE_SHA $HEAD_SHA -- $TRANSLATABLE_FILES)
+
+TEMPLATE="Sync changes from upstream\n\n"
+
+if [ -z "$CHANGED_FILES" ]; then
+  TEMPLATE="$TEMPLATE\nNo files that need translation were changed upstream."
+else
+  TEMPLATE="$TEMPLATE\nCheck the changes in each of these files and update the translation accordingly:\n"
+
+  for file in $CHANGED_FILES; do
+    TEMPLATE="$TEMPLATE\n- [ ] \`$file\`"
+  done
+fi
+
+OWNER=$(git config --get remote.$REMOTE.url | sed -Ene 's#.*github.com[/:]([^/]*)/.*#\1#p')
+
+echo $TEMPLATE | hub pull-request -o -F - -b $OWNER:gh-pages -h $OWNER:$BRANCH