create-pull-request 7.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258
  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. -c Create an RFC (Request for Comment) patch series
  37. -h Display this help message
  38. -i commit_id Ending commit (default: HEAD)
  39. -m msg_body_file The file containing a blurb to be inserted into the summary email
  40. -o output_dir Specify the output directory for the messages (default: pull-PID)
  41. -p prefix Use [prefix N/M] instead of [PATCH N/M] as the subject prefix
  42. -r relative_to Starting commit (default: master)
  43. -s subject The subject to be inserted into the summary email
  44. -u remote The git remote where the branch is located
  45. -d relative_dir Generate patches relative to directory
  46. Examples:
  47. $CMD -u contrib -b nitin/basic
  48. $CMD -u contrib -r distro/master -i nitin/distro -b nitin/distro
  49. $CMD -u contrib -r master -i misc -b nitin/misc -o pull-misc
  50. $CMD -u contrib -p "RFC PATCH" -b nitin/experimental
  51. $CMD -u contrib -i misc -b nitin/misc -d ./bitbake
  52. EOM
  53. }
  54. # Parse and validate arguments
  55. while getopts "b:cd:hi:m:o:p:r:s:u:" OPT; do
  56. case $OPT in
  57. b)
  58. BRANCH="$OPTARG"
  59. ;;
  60. c)
  61. RFC=1
  62. ;;
  63. d)
  64. RELDIR="$OPTARG"
  65. ;;
  66. h)
  67. usage
  68. exit 0
  69. ;;
  70. i)
  71. COMMIT_ID="$OPTARG"
  72. ;;
  73. m)
  74. BODY="$OPTARG"
  75. if [ ! -e "$BODY" ]; then
  76. echo "ERROR: Body file does not exist"
  77. exit 1
  78. fi
  79. ;;
  80. o)
  81. ODIR="$OPTARG"
  82. ;;
  83. p)
  84. PREFIX="$OPTARG"
  85. ;;
  86. r)
  87. RELATIVE_TO="$OPTARG"
  88. ;;
  89. s)
  90. SUBJECT="$OPTARG"
  91. ;;
  92. u)
  93. REMOTE="$OPTARG"
  94. REMOTE_URL=$(git config remote.$REMOTE.url)
  95. if [ $? -ne 0 ]; then
  96. echo "ERROR: git config failed to find a url for '$REMOTE'"
  97. echo
  98. echo "To add a remote url for $REMOTE, use:"
  99. echo " git config remote.$REMOTE.url <url>"
  100. exit 1
  101. fi
  102. # Rewrite private URLs to public URLs
  103. # Determine the repository name for use in the WEB_URL later
  104. case "$REMOTE_URL" in
  105. *@*)
  106. USER_RE="[A-Za-z0-9_.@][A-Za-z0-9_.@-]*\$\?"
  107. PROTO_RE="[a-z][a-z+]*://"
  108. GIT_RE="\(^\($PROTO_RE\)\?$USER_RE@\)\([^:/]*\)[:/]\(.*\)"
  109. REMOTE_URL=${REMOTE_URL%.git}
  110. REMOTE_REPO=$(echo $REMOTE_URL | sed "s#$GIT_RE#\4#")
  111. REMOTE_URL=$(echo $REMOTE_URL | sed "s#$GIT_RE#git://\3/\4#")
  112. ;;
  113. *)
  114. echo "WARNING: Unrecognized remote URL: $REMOTE_URL"
  115. echo " The pull and browse URLs will likely be incorrect"
  116. ;;
  117. esac
  118. ;;
  119. esac
  120. done
  121. if [ -z "$BRANCH" ]; then
  122. BRANCH=$(git branch | grep -e "^\* " | cut -d' ' -f2)
  123. echo "NOTE: Assuming remote branch '$BRANCH', use -b to override."
  124. fi
  125. if [ -z "$REMOTE_URL" ]; then
  126. echo "ERROR: Missing parameter -u, no git remote!"
  127. usage
  128. exit 1
  129. fi
  130. if [ $RFC -eq 1 ]; then
  131. PREFIX="RFC $PREFIX"
  132. fi
  133. # Set WEB_URL from known remotes
  134. WEB_URL=""
  135. case "$REMOTE_URL" in
  136. *git.yoctoproject.org*)
  137. WEB_URL="http://git.yoctoproject.org/cgit.cgi/$REMOTE_REPO/log/?h=$BRANCH"
  138. ;;
  139. *git.pokylinux.org*)
  140. WEB_URL="http://git.pokylinux.org/cgit.cgi/$REMOTE_REPO/log/?h=$BRANCH"
  141. ;;
  142. *git.openembedded.org*)
  143. WEB_URL="http://cgit.openembedded.org/cgit.cgi/$REMOTE_REPO/log/?h=$BRANCH"
  144. ;;
  145. *github.com*)
  146. WEB_URL="https://github.com/$REMOTE_REPO/tree/$BRANCH"
  147. ;;
  148. esac
  149. # Perform a sanity test on the web URL. Issue a warning if it is not
  150. # accessible, but do not abort as users may want to run offline.
  151. if [ -n "$WEB_URL" ]; then
  152. wget --no-check-certificate -q $WEB_URL -O /dev/null
  153. if [ $? -ne 0 ]; then
  154. echo "WARNING: Branch '$BRANCH' was not found on the contrib git tree."
  155. echo " Please check your remote and branch parameter before sending."
  156. echo ""
  157. fi
  158. fi
  159. if [ -e $ODIR ]; then
  160. echo "ERROR: output directory $ODIR exists."
  161. exit 1
  162. fi
  163. mkdir $ODIR
  164. if [ -n "$RELDIR" ]; then
  165. ODIR=$(realpath $ODIR)
  166. pdir=$(pwd)
  167. cd $RELDIR
  168. extraopts="--relative"
  169. fi
  170. # Generate the patches and cover letter
  171. git format-patch $extraopts -M40 --subject-prefix="$PREFIX" -n -o $ODIR --thread=shallow --cover-letter $RELATIVE_TO..$COMMIT_ID > /dev/null
  172. [ -n "$RELDIR" ] && cd $pdir
  173. # Customize the cover letter
  174. CL="$ODIR/0000-cover-letter.patch"
  175. PM="$ODIR/pull-msg"
  176. GIT_VERSION=$(`git --version` | tr -d '[:alpha:][:space:].' | sed 's/\(...\).*/\1/')
  177. NEWER_GIT_VERSION=210
  178. if [ $GIT_VERSION -lt $NEWER_GIT_VERSION ]; then
  179. git request-pull $RELATIVE_TO $REMOTE_URL $COMMIT_ID >> "$PM"
  180. else
  181. git request-pull $RELATIVE_TO $REMOTE_URL :$BRANCH >> "$PM"
  182. fi
  183. if [ $? -ne 0 ]; then
  184. echo "ERROR: git request-pull reported an error"
  185. exit 1
  186. fi
  187. # The cover letter already has a diffstat, remove it from the pull-msg
  188. # before inserting it.
  189. sed -n "0,\#$REMOTE_URL# p" "$PM" | sed -i "/BLURB HERE/ r /dev/stdin" "$CL"
  190. rm "$PM"
  191. # If this is an RFC, make that clear in the cover letter
  192. if [ $RFC -eq 1 ]; then
  193. (cat <<EOM
  194. Please review the following changes for suitability for inclusion. If you have
  195. any objections or suggestions for improvement, please respond to the patches. If
  196. you agree with the changes, please provide your Acked-by.
  197. EOM
  198. ) | sed -i "/BLURB HERE/ r /dev/stdin" "$CL"
  199. fi
  200. # Insert the WEB_URL if there is one
  201. if [ -n "$WEB_URL" ]; then
  202. echo " $WEB_URL" | sed -i "\#$REMOTE_URL# r /dev/stdin" "$CL"
  203. fi
  204. # If the user specified a message body, insert it into the cover letter and
  205. # remove the BLURB token.
  206. if [ -n "$BODY" ]; then
  207. sed -i "/BLURB HERE/ r $BODY" "$CL"
  208. sed -i "/BLURB HERE/ d" "$CL"
  209. fi
  210. # If the user specified a subject, replace the SUBJECT token with it.
  211. if [ -n "$SUBJECT" ]; then
  212. sed -i -e "s/\*\*\* SUBJECT HERE \*\*\*/$SUBJECT/" "$CL"
  213. fi
  214. # Generate report for user
  215. cat <<EOM
  216. The following patches have been prepared:
  217. $(for PATCH in $(ls $ODIR/*); do echo " $PATCH"; done)
  218. Review their content, especially the summary mail:
  219. $CL
  220. When you are satisfied, you can send them with:
  221. send-pull-request -a -p $ODIR
  222. EOM
  223. # Check the patches for trailing white space
  224. egrep -q -e "^\+.*\s+$" $ODIR/*
  225. if [ $? -ne 1 ]; then
  226. echo
  227. echo "WARNING: Trailing white space detected at these locations"
  228. egrep -nH --color -e "^\+.*\s+$" $ODIR/*
  229. fi