create-pull-request 8.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  1. #!/bin/sh
  2. #
  3. # Copyright (c) 2010-2013, Intel Corporation.
  4. # All Rights Reserved
  5. #
  6. # This program is free software; you can redistribute it and/or modify
  7. # it under the terms of the GNU General Public License as published by
  8. # the Free Software Foundation; either version 2 of the License, or
  9. # (at your option) any later version.
  10. #
  11. # This program is distributed in the hope that it will be useful,
  12. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  13. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See
  14. # the GNU General Public License for more details.
  15. #
  16. # You should have received a copy of the GNU General Public License
  17. # along with this program; if not, write to the Free Software
  18. # Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  19. #
  20. #
  21. # This script is intended to be used to prepare a series of patches
  22. # and a cover letter in an appropriate and consistent format for
  23. # submission to Open Embedded and The Yocto Project, as well as to
  24. # related projects and layers.
  25. #
  26. ODIR=pull-$$
  27. RELATIVE_TO="master"
  28. COMMIT_ID="HEAD"
  29. PREFIX="PATCH"
  30. RFC=0
  31. usage() {
  32. CMD=$(basename $0)
  33. cat <<EOM
  34. Usage: $CMD [-h] [-o output_dir] [-m msg_body_file] [-s subject] [-r relative_to] [-i commit_id] [-d relative_dir] -u remote [-b branch]
  35. -b branch Branch name in the specified remote (default: current branch)
  36. -l local branch Local branch name (default: HEAD)
  37. -c Create an RFC (Request for Comment) patch series
  38. -h Display this help message
  39. -a Automatically push local branch (-l) to remote branch (-b),
  40. or set CPR_CONTRIB_AUTO_PUSH in env
  41. -i commit_id Ending commit (default: HEAD)
  42. -m msg_body_file The file containing a blurb to be inserted into the summary email
  43. -o output_dir Specify the output directory for the messages (default: pull-PID)
  44. -p prefix Use [prefix N/M] instead of [PATCH N/M] as the subject prefix
  45. -r relative_to Starting commit (default: master)
  46. -s subject The subject to be inserted into the summary email
  47. -u remote The git remote where the branch is located, or set CPR_CONTRIB_REMOTE in env
  48. -d relative_dir Generate patches relative to directory
  49. Examples:
  50. $CMD -u contrib -b nitin/basic
  51. $CMD -u contrib -r distro/master -i nitin/distro -b nitin/distro
  52. $CMD -u contrib -r distro/master -i nitin/distro -b nitin/distro -l distro
  53. $CMD -u contrib -r master -i misc -b nitin/misc -o pull-misc
  54. $CMD -u contrib -p "RFC PATCH" -b nitin/experimental
  55. $CMD -u contrib -i misc -b nitin/misc -d ./bitbake
  56. EOM
  57. }
  58. REMOTE="$CPR_CONTRIB_REMOTE"
  59. # Parse and validate arguments
  60. while getopts "b:acd:hi:m:o:p:r:s:u:l:" OPT; do
  61. case $OPT in
  62. b)
  63. BRANCH="$OPTARG"
  64. ;;
  65. l)
  66. L_BRANCH="$OPTARG"
  67. ;;
  68. c)
  69. RFC=1
  70. ;;
  71. d)
  72. RELDIR="$OPTARG"
  73. ;;
  74. h)
  75. usage
  76. exit 0
  77. ;;
  78. i)
  79. COMMIT_ID="$OPTARG"
  80. ;;
  81. m)
  82. BODY="$OPTARG"
  83. if [ ! -e "$BODY" ]; then
  84. echo "ERROR: Body file does not exist"
  85. exit 1
  86. fi
  87. ;;
  88. o)
  89. ODIR="$OPTARG"
  90. ;;
  91. p)
  92. PREFIX="$OPTARG"
  93. ;;
  94. r)
  95. RELATIVE_TO="$OPTARG"
  96. ;;
  97. s)
  98. SUBJECT="$OPTARG"
  99. ;;
  100. u)
  101. REMOTE="$OPTARG"
  102. ;;
  103. a)
  104. CPR_CONTRIB_AUTO_PUSH="1"
  105. ;;
  106. esac
  107. done
  108. if [ -z "$REMOTE" ]; then
  109. echo "ERROR: Missing parameter -u or CPR_CONTRIB_REMOTE in env, no git remote!"
  110. usage
  111. exit 1
  112. fi
  113. REMOTE_URL=$(git config remote.$REMOTE.url)
  114. if [ $? -ne 0 ]; then
  115. echo "ERROR: git config failed to find a url for '$REMOTE'"
  116. echo
  117. echo "To add a remote url for $REMOTE, use:"
  118. echo " git config remote.$REMOTE.url <url>"
  119. exit 1
  120. fi
  121. # Rewrite private URLs to public URLs
  122. # Determine the repository name for use in the WEB_URL later
  123. case "$REMOTE_URL" in
  124. *@*)
  125. USER_RE="[A-Za-z0-9_.@][A-Za-z0-9_.@-]*\$\?"
  126. PROTO_RE="[a-z][a-z+]*://"
  127. GIT_RE="\(^\($PROTO_RE\)\?$USER_RE@\)\([^:/]*\)[:/]\(.*\)"
  128. REMOTE_URL=${REMOTE_URL%.git}
  129. REMOTE_REPO=$(echo $REMOTE_URL | sed "s#$GIT_RE#\4#")
  130. REMOTE_URL=$(echo $REMOTE_URL | sed "s#$GIT_RE#git://\3/\4#")
  131. ;;
  132. *)
  133. echo "WARNING: Unrecognized remote URL: $REMOTE_URL"
  134. echo " The pull and browse URLs will likely be incorrect"
  135. ;;
  136. esac
  137. if [ -z "$BRANCH" ]; then
  138. BRANCH=$(git branch | grep -e "^\* " | cut -d' ' -f2)
  139. echo "NOTE: Assuming remote branch '$BRANCH', use -b to override."
  140. fi
  141. if [ -z "$L_BRANCH" ]; then
  142. L_BRANCH=HEAD
  143. echo "NOTE: Assuming local branch HEAD, use -l to override."
  144. fi
  145. if [ $RFC -eq 1 ]; then
  146. PREFIX="RFC $PREFIX"
  147. fi
  148. # Set WEB_URL from known remotes
  149. WEB_URL=""
  150. case "$REMOTE_URL" in
  151. *git.yoctoproject.org*)
  152. WEB_URL="http://git.yoctoproject.org/cgit.cgi/$REMOTE_REPO/log/?h=$BRANCH"
  153. ;;
  154. *git.pokylinux.org*)
  155. WEB_URL="http://git.pokylinux.org/cgit.cgi/$REMOTE_REPO/log/?h=$BRANCH"
  156. ;;
  157. *git.openembedded.org*)
  158. WEB_URL="http://cgit.openembedded.org/$REMOTE_REPO/log/?h=$BRANCH"
  159. ;;
  160. *github.com*)
  161. WEB_URL="https://github.com/$REMOTE_REPO/tree/$BRANCH"
  162. ;;
  163. esac
  164. # Perform a sanity test on the web URL. Issue a warning if it is not
  165. # accessible, but do not abort as users may want to run offline.
  166. if [ -n "$WEB_URL" ]; then
  167. if [ "$CPR_CONTRIB_AUTO_PUSH" = "1" ]; then
  168. echo "Pushing '$BRANCH' on '$REMOTE' as requested..."
  169. git push $REMOTE $L_BRANCH:$BRANCH
  170. echo ""
  171. fi
  172. wget --no-check-certificate -q $WEB_URL -O /dev/null
  173. if [ $? -ne 0 ]; then
  174. echo "WARNING: Branch '$BRANCH' was not found on the contrib git tree."
  175. echo " Please check your remote and branch parameter before sending."
  176. echo ""
  177. fi
  178. fi
  179. if [ -e $ODIR ]; then
  180. echo "ERROR: output directory $ODIR exists."
  181. exit 1
  182. fi
  183. mkdir $ODIR
  184. if [ -n "$RELDIR" ]; then
  185. ODIR=$(realpath $ODIR)
  186. pdir=$(pwd)
  187. cd $RELDIR
  188. extraopts="--relative"
  189. fi
  190. # Generate the patches and cover letter
  191. git format-patch $extraopts -M40 --subject-prefix="$PREFIX" -n -o $ODIR --thread=shallow --cover-letter $RELATIVE_TO..$COMMIT_ID > /dev/null
  192. if [ -z "$(ls -A $ODIR 2> /dev/null)" ]; then
  193. echo "ERROR: $ODIR is empty, no cover letter and patches was generated!"
  194. echo " This is most likely due to that \$RRELATIVE_TO..\$COMMIT_ID"
  195. echo " ($RELATIVE_TO..$COMMIT_ID) don't contain any differences."
  196. rmdir $ODIR
  197. exit 1
  198. fi
  199. [ -n "$RELDIR" ] && cd $pdir
  200. # Customize the cover letter
  201. CL="$ODIR/0000-cover-letter.patch"
  202. PM="$ODIR/pull-msg"
  203. GIT_VERSION=$(`git --version` | tr -d '[:alpha:][:space:].' | sed 's/\(...\).*/\1/')
  204. NEWER_GIT_VERSION=210
  205. if [ $GIT_VERSION -lt $NEWER_GIT_VERSION ]; then
  206. git request-pull $RELATIVE_TO $REMOTE_URL $COMMIT_ID >> "$PM"
  207. else
  208. git request-pull $RELATIVE_TO $REMOTE_URL $L_BRANCH:$BRANCH >> "$PM"
  209. fi
  210. if [ $? -ne 0 ]; then
  211. echo "ERROR: git request-pull reported an error"
  212. rm -rf $ODIR
  213. exit 1
  214. fi
  215. # The cover letter already has a diffstat, remove it from the pull-msg
  216. # before inserting it.
  217. sed -n "0,\#$REMOTE_URL# p" "$PM" | sed -i "/BLURB HERE/ r /dev/stdin" "$CL"
  218. rm "$PM"
  219. # If this is an RFC, make that clear in the cover letter
  220. if [ $RFC -eq 1 ]; then
  221. (cat <<EOM
  222. Please review the following changes for suitability for inclusion. If you have
  223. any objections or suggestions for improvement, please respond to the patches. If
  224. you agree with the changes, please provide your Acked-by.
  225. EOM
  226. ) | sed -i "/BLURB HERE/ r /dev/stdin" "$CL"
  227. fi
  228. # Insert the WEB_URL if there is one
  229. if [ -n "$WEB_URL" ]; then
  230. echo " $WEB_URL" | sed -i "\#$REMOTE_URL# r /dev/stdin" "$CL"
  231. fi
  232. # If the user specified a message body, insert it into the cover letter and
  233. # remove the BLURB token.
  234. if [ -n "$BODY" ]; then
  235. sed -i "/BLURB HERE/ r $BODY" "$CL"
  236. sed -i "/BLURB HERE/ d" "$CL"
  237. fi
  238. # Set subject automatically if there is only one patch
  239. patch_cnt=`git log --pretty=oneline ${RELATIVE_TO}..${L_BRANCH} | wc -l`
  240. if [ -z "$SUBJECT" -a $patch_cnt -eq 1 ]; then
  241. SUBJECT="`git log --format=%s ${RELATIVE_TO}..${L_BRANCH}`"
  242. fi
  243. # Replace the SUBJECT token with it.
  244. if [ -n "$SUBJECT" ]; then
  245. sed -i -e "s/\*\*\* SUBJECT HERE \*\*\*/$SUBJECT/" "$CL"
  246. fi
  247. # Generate report for user
  248. cat <<EOM
  249. The following patches have been prepared:
  250. $(for PATCH in $(ls $ODIR/*); do echo " $PATCH"; done)
  251. Review their content, especially the summary mail:
  252. $CL
  253. When you are satisfied, you can send them with:
  254. send-pull-request -a -p $ODIR
  255. EOM
  256. # Check the patches for trailing white space
  257. egrep -q -e "^\+.*\s+$" $ODIR/*
  258. if [ $? -ne 1 ]; then
  259. echo
  260. echo "WARNING: Trailing white space detected at these locations"
  261. egrep -nH --color -e "^\+.*\s+$" $ODIR/*
  262. fi