<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[6858] sites/trunk/wordcamp.org: WordCamp Git Hooks: Add `pre-svn-dcommit`.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/6858">6858</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/6858","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>iandunn</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2018-03-10 22:08:36 +0000 (Sat, 10 Mar 2018)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>WordCamp Git Hooks: Add `pre-svn-dcommit`.</pre>
<h3>Added Paths</h3>
<ul>
<li>sites/trunk/wordcamp.org/.githooks/</li>
<li><a href="#sitestrunkwordcamporggithooksREADMEmd">sites/trunk/wordcamp.org/.githooks/README.md</a></li>
<li><a href="#sitestrunkwordcamporggithookspresvndcommit">sites/trunk/wordcamp.org/.githooks/pre-svn-dcommit</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporggithooksREADMEmd"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordcamp.org/.githooks/README.md</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/.githooks/README.md (rev 0)
+++ sites/trunk/wordcamp.org/.githooks/README.md 2018-03-10 22:08:36 UTC (rev 6858)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,25 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+# Setup Instructions
+
+
+## General
+
+1. `rm -rf .git/hooks`
+1. `ln -s ../path/to/.githooks .git/hooks`
+1. If you have multiple Git checkouts (e.g., one for `mu-plugins`, and another for `mu-plugins-private`), then
+ you'll need to repeat the above steps for each of them.
+
+Aside: Why not use native Subversion hooks? Because they run on the server, which prevents a developer from choosing to force the push anyway. It would also require work from the Systems team, who doesn't have the time.
+
+
+## git svn dcommit
+
+git-svn doesn't support hooks natively, so we'll use an alias instead.
+
+1. Add the following to your `.gitconfig`:
+
+ ```
+ [alias]
+ svnpush = !sh .git/hooks/pre-svn-dcommit && git svn dcommit --interactive
+ ```
+
+1. When you're ready to push, call `git svnpush` instead of `git svn dcommit`.
</ins></span></pre></div>
<a id="sitestrunkwordcamporggithookspresvndcommit"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordcamp.org/.githooks/pre-svn-dcommit</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/.githooks/pre-svn-dcommit (rev 0)
+++ sites/trunk/wordcamp.org/.githooks/pre-svn-dcommit 2018-03-10 22:08:36 UTC (rev 6858)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,131 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+#!/bin/sh
+
+# See README.md for setup instructions.
+
+# TODO
+#
+# - Restrict changed files to only PHP for `php -l` and PHPMD, then PHP and CSS for PHPCS.
+# - This all assumes that the state is clean. If a changed file is dirty, `php -l`, etc will be run against the
+# dirty file on disk, not the contents of that file at `HEAD`. We could maybe stash unstaged changes, run this
+# then pop the stash, but that feels bad. Line numbers wouldn't necessary match up between `php -l` output and
+# the file after popping the stash, and there may be merge conflicts when popping in some cases?
+# - Only run PHPCS/PHPMD over changed lines, not entire files?
+# - Maybe make these functions more DRY, since they're all pretty similar.
+#
+
+
+# Get the files that have changes between the local and remote HEADs.
+function get_changed_files {
+ changed_files=$( /usr/bin/git diff git-svn HEAD --name-only )
+}
+
+# Lint PHP files for syntax errors.
+function php_lint {
+ local errors=false
+
+ for file in $changed_files; do
+ output=$( /usr/local/bin/php -l -d display_errors=1 $file )
+
+ if [ $? != 0 ]; then
+ errors=true
+
+ for line in "${output[@]}"; do
+ echo "${color_error} $line ${color_reset}"
+ done
+ fi
+ done
+
+ if [[ $errors == true ]]; then
+ exit 1
+ fi
+}
+
+# Run PHP Code Sniffer to check for coding standards violations.
+function phpcs {
+ local errors=false
+
+ for file in $changed_files; do
+ output=$( /usr/local/bin/phpcs $file )
+
+ if [ $? != 0 ]; then
+ errors=true
+
+ for line in "${output[@]}"; do
+ echo "$line"
+ done
+ fi
+ done
+
+ if [[ $errors == true ]]; then
+ prompt_to_continue
+ fi
+}
+
+# Run PHP Mess Detector to check for poor-quality code.
+function phpmd {
+ local errors=false
+ local config=$( search_tree "phpmd.xml.dist" )
+
+ for file in $changed_files; do
+ output=$( /usr/local/bin/phpmd $file text $config )
+
+ if [ $? != 0 ]; then
+ errors=true
+
+ for line in "${output[@]}"; do
+ echo "${color_warn} $line ${color_reset}"
+ done
+ fi
+ done
+
+ if [[ $errors == true ]]; then
+ prompt_to_continue
+ fi
+}
+
+# Search up the directory tree for the given file.
+#
+# $1 - The filename to find.
+function search_tree {
+ local folder=$PWD
+ local file=${1}
+ local path=false
+
+ while [[ '/' != $folder ]]; do
+ if [[ -f $folder/$file ]]; then
+ path=$folder/$file
+ break
+ fi
+
+ folder=$( dirname $folder )
+ done
+
+ echo "$path"
+}
+
+# Prompt the user to abort or continue running the script.
+function prompt_to_continue {
+ printf "\nDo you want to procede despite the errors above? [y/N] "
+ read PROCEED
+
+ if [[ 'y' != $PROCEED ]]; then
+ printf "\nAborting.\n"
+ exit 1
+ fi
+}
+
+function main {
+ color_reset="\033[m"
+ color_error="\033[1;31m" # red
+ color_warn="\033[1;33m" # yellow
+
+ get_changed_files
+
+ php_lint
+ phpcs
+ phpmd
+
+ echo "\nProceeding with push.\n"
+}
+
+main
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordcamp.org/.githooks/pre-svn-dcommit
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svnexecutable"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:executable</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+*
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span></div>
</body>
</html>