git.droids-corp.org - git-central.git/blob

1 #!/bin/sh

2 #

4 #

5 # An example hook script to mail out commit update information. This hook

6 # sends emails listing new revisions to the repository introduced by the

7 # change being reported. The rule is that (for branch updates) each commit

8 # will appear on one email and one email only.

9 #

10 # This hook is stored in the contrib/hooks directory. Your distribution

11 # will have put this somewhere standard. You should make this script

12 # executable then link to it in the repository you would like to use it in.

13 # For example, on debian the hook is stored in

14 # /usr/share/doc/git-core/contrib/hooks/post-receive-email:

15 #

16 # chmod a+x post-receive-email

17 # cd /path/to/your/repository.git

18 # ln -sf /usr/share/doc/git-core/contrib/hooks/post-receive-email hooks/post-receive

19 #

20 # This hook script assumes it is enabled on the central repository of a

21 # project, with all users pushing only to it and not between each other. It

22 # will still work if you don't operate in that style, but it would become

23 # possible for the email to be from someone other than the person doing the

24 # push.

25 #

26 # Config

27 # ------

28 # hooks.mailinglist

29 # This is the list that all pushes will go to; leave it blank to not send

30 # emails for every ref update.

31 # hooks.announcelist

32 # This is the list that all pushes of annotated tags will go to. Leave it

33 # blank to default to the mailinglist field. The announce emails lists

34 # the short log summary of the changes since the last annotated tag.

35 # hooks.envelopesender

36 # If set then the -f option is passed to sendmail to allow the envelope

37 # sender address to be set

38 # hooks.emailprefix

39 # All emails have their subjects prefixed with this prefix, or "[SCM]"

40 # if emailprefix is unset, to aid filtering

41 #

42 # Notes

43 # -----

44 # All emails include the headers "X-Git-Refname", "X-Git-Oldrev",

45 # "X-Git-Newrev", and "X-Git-Reftype" to enable fine tuned filtering and

46 # give information for debugging.

47 #

48

49 # ---------------------------- Functions

50

51 #

52 # Top level email generation function. This decides what type of update

53 # this is and calls the appropriate body-generation routine after outputting

54 # the common header

55 #

56 # Note this function doesn't actually generate any email output, that is

57 # taken care of by the functions it calls:

58 # - generate_email_header

59 # - generate_create_XXXX_email

60 # - generate_update_XXXX_email

61 # - generate_delete_XXXX_email

62 # - generate_email_footer

63 #

64 generate_email()

65 {

66 # --- Arguments

67 oldrev=$(git rev-parse $1)

68 newrev=$(git rev-parse $2)

69 refname="$3"

70

71 # --- Interpret

72 # 0000->1234 (create)

73 # 1234->2345 (update)

74 # 2345->0000 (delete)

75 if expr "$oldrev" : '0*$' >/dev/null

76 then

77 change_type="create"

78 else

79 if expr "$newrev" : '0*$' >/dev/null

80 then

81 change_type="delete"

82 else

83 change_type="update"

84 fi

85 fi

86

87 # --- Get the revision types

88 newrev_type=$(git cat-file -t $newrev 2> /dev/null)

89 oldrev_type=$(git cat-file -t "$oldrev" 2> /dev/null)

90 case "$change_type" in

91 create|update)

92 rev="$newrev"

93 rev_type="$newrev_type"

94 ;;

95 delete)

96 rev="$oldrev"

97 rev_type="$oldrev_type"

98 ;;

99 esac

100

101 # The revision type tells us what type the commit is, combined with

102 # the location of the ref we can decide between

103 # - working branch

104 # - tracking branch

105 # - unannoted tag

106 # - annotated tag

107 case "$refname","$rev_type" in

108 refs/tags/*,commit)

109 # un-annotated tag

110 refname_type="tag"

111 short_refname=${refname##refs/tags/}

112 ;;

113 refs/tags/*,tag)

114 # annotated tag

115 refname_type="annotated tag"

116 short_refname=${refname##refs/tags/}

117 # change recipients

118 if [ -n "$announcerecipients" ]; then

119 recipients="$announcerecipients"

120 fi

121 ;;

122 refs/heads/*,commit)

123 # branch

124 refname_type="branch"

125 short_refname=${refname##refs/heads/}

126 ;;

127 refs/remotes/*,commit)

128 # tracking branch

129 refname_type="tracking branch"

130 short_refname=${refname##refs/remotes/}

131 echo >&2 "*** Push-update of tracking branch, $refname"

132 echo >&2 "*** - no email generated."

133 exit 0

134 ;;

135 *)

136 # Anything else (is there anything else?)

137 echo >&2 "*** Unknown type of update to $refname ($rev_type)"

138 echo >&2 "*** - no email generated"

139 exit 1

140 ;;

141 esac

142

143 # Check if we've got anyone to send to

144 if [ -z "$recipients" ]; then

145 case "$refname_type" in

146 "annotated tag")

147 config_name="hooks.announcelist"

148 ;;

149 *)

150 config_name="hooks.mailinglist"

151 ;;

152 esac

153 echo >&2 "*** $config_name is not set so no email will be sent"

154 echo >&2 "*** for $refname update $oldrev->$newrev"

155 exit 0

156 fi

157

158 # Email parameters

159 # The email subject will contain the best description of the ref

160 # that we can build from the parameters

161 describe=$(git describe $rev 2>/dev/null)

162 if [ -z "$describe" ]; then

163 describe=$rev

164 fi

165

166 generate_email_header

167

168 # Call the correct body generation function

169 fn_name=general

170 case "$refname_type" in

171 "tracking branch"|branch)

172 fn_name=branch

173 ;;

174 "annotated tag")

175 fn_name=atag

176 ;;

177 esac

178 generate_${change_type}_${fn_name}_email

179

180 generate_email_footer

181 }

182

183 generate_email_header()

184 {

185 # --- Email (all stdout will be the email)

186 # Generate header

187 cat <<-EOF

188 To: $recipients

189 Subject: ${emailprefix}$projectdesc $refname_type, $short_refname, ${change_type}d. $describe

190 X-Git-Refname: $refname

191 X-Git-Reftype: $refname_type

192 X-Git-Oldrev: $oldrev

193 X-Git-Newrev: $newrev

194

195 This is an automated email from the git hooks/post-receive script. It was

196 generated because a ref change was pushed to the repository containing

197 the project "$projectdesc".

198

199 The $refname_type, $short_refname has been ${change_type}d

200 EOF

201 }

202

203 generate_email_footer()

204 {

205 SPACE=" "

206 cat <<-EOF

207

208

209 hooks/post-receive

210 --${SPACE}

211 $projectdesc

212 EOF

213 }

214

215 # --------------- Branches

216

217 #

218 # Called for the creation of a branch

219 #

220 generate_create_branch_email()

221 {

222 # This is a new branch and so oldrev is not valid

223 echo " at $newrev ($newrev_type)"

224 echo ""

225

226 echo $LOGBEGIN

227 # This shows all log entries that are not already covered by

228 # another ref - i.e. commits that are now accessible from this

229 # ref that were previously not accessible

230 # (see generate_update_branch_email for the explanation of this

231 # command)

232 git rev-parse --not --branches | grep -v $(git rev-parse $refname) |

233 git rev-list --pretty --reverse --stdin $newrev

234 echo $LOGEND

235

236 echo ""

237 echo "Summary of changes:"

238 git diff-tree --stat -p $newrev

239 }

240

241 #

242 # Called for the change of a pre-existing branch

243 #

244 generate_update_branch_email()

245 {

246 # Consider this:

247 # 1 --- 2 --- O --- X --- 3 --- 4 --- N

248 #

249 # O is $oldrev for $refname

250 # N is $newrev for $refname

251 # X is a revision pointed to by some other ref, for which we may

252 # assume that an email has already been generated.

253 # In this case we want to issue an email containing only revisions

254 # 3, 4, and N. Given (almost) by

255 #

256 # git rev-list N ^O --not --all

257 #

258 # The reason for the "almost", is that the "--not --all" will take

259 # precedence over the "N", and effectively will translate to

260 #

261 # git rev-list N ^O ^X ^N

262 #

263 # So, we need to build up the list more carefully. git rev-parse

264 # will generate a list of revs that may be fed into git rev-list.

265 # We can get it to make the "--not --all" part and then filter out

266 # the "^N" with:

267 #

268 # git rev-parse --not --all | grep -v N

269 #

270 # Then, using the --stdin switch to git rev-list we have effectively

271 # manufactured

272 #

273 # git rev-list N ^O ^X

274 #

275 # This leaves a problem when someone else updates the repository

276 # while this script is running. Their new value of the ref we're

277 # working on would be included in the "--not --all" output; and as

278 # our $newrev would be an ancestor of that commit, it would exclude

279 # all of our commits. What we really want is to exclude the current

280 # value of $refname from the --not list, rather than N itself. So:

281 #

282 # git rev-parse --not --all | grep -v $(git rev-parse $refname)

283 #

284 # Get's us to something pretty safe (apart from the small time

285 # between refname being read, and git rev-parse running - for that,

286 # I give up)

287 #

288 #

289 # Next problem, consider this:

290 # * --- B --- * --- O ($oldrev)

291 # \

292 # * --- X --- * --- N ($newrev)

293 #

294 # That is to say, there is no guarantee that oldrev is a strict

295 # subset of newrev (it would have required a --force, but that's

296 # allowed). So, we can't simply say rev-list $oldrev..$newrev.

297 # Instead we find the common base of the two revs and list from

298 # there.

299 #

300 # As above, we need to take into account the presence of X; if

301 # another branch is already in the repository and points at some of

302 # the revisions that we are about to output - we don't want them.

303 # The solution is as before: git rev-parse output filtered.

304 #

305 # Finally, tags: 1 --- 2 --- O --- T --- 3 --- 4 --- N

306 #

307 # Tags pushed into the repository generate nice shortlog emails that

308 # summarise the commits between them and the previous tag. However,

309 # those emails don't include the full commit messages that we output

310 # for a branch update. Therefore we still want to output revisions

311 # that have been output on a tag email.

312 #

313 # Luckily, git rev-parse includes just the tool. Instead of using

314 # "--all" we use "--branches"; this has the added benefit that

315 # "remotes/" will be ignored as well.

316

317 # List all of the revisions that were removed by this update, in a

318 # fast forward update, this list will be empty, because rev-list O

319 # ^N is empty. For a non fast forward, O ^N is the list of removed

320 # revisions

321 fast_forward=""

322 rev=""

323 for rev in $(git rev-list $newrev..$oldrev)

324 do

325 revtype=$(git cat-file -t "$rev")

326 echo " discards $rev ($revtype)"

327 done

328 if [ -z "$rev" ]; then

329 fast_forward=1

330 fi

331

332 # List all the revisions from baserev to newrev in a kind of

333 # "table-of-contents"; note this list can include revisions that

334 # have already had notification emails and is present to show the

335 # full detail of the change from rolling back the old revision to

336 # the base revision and then forward to the new revision

337 for rev in $(git rev-list $oldrev..$newrev)

338 do

339 revtype=$(git cat-file -t "$rev")

340 echo " via $rev ($revtype)"

341 done

342

343 if [ "$fast_forward" ]; then

344 echo " from $oldrev ($oldrev_type)"

345 else

346 # 1. Existing revisions were removed. In this case newrev

347 # is a subset of oldrev - this is the reverse of a

348 # fast-forward, a rewind

349 # 2. New revisions were added on top of an old revision,

350 # this is a rewind and addition.

351

352 # (1) certainly happened, (2) possibly. When (2) hasn't

353 # happened, we set a flag to indicate that no log printout

354 # is required.

355

356 echo ""

357

358 # Find the common ancestor of the old and new revisions and

359 # compare it with newrev

360 baserev=$(git merge-base $oldrev $newrev)

361 rewind_only=""

362 if [ "$baserev" = "$newrev" ]; then

363 echo "This update discarded existing revisions and left the branch pointing at"

364 echo "a previous point in the repository history."

365 echo ""

366 echo " * -- * -- N ($newrev)"

367 echo " \\"

368 echo " O -- O -- O ($oldrev)"

369 echo ""

370 echo "The removed revisions are not necessarilly gone - if another reference"

371 echo "still refers to them they will stay in the repository."

372 rewind_only=1

373 else

374 echo "This update added new revisions after undoing existing revisions. That is"

375 echo "to say, the old revision is not a strict subset of the new revision. This"

376 echo "situation occurs when you --force push a change and generate a repository"

377 echo "containing something like this:"

378 echo ""

379 echo " * -- * -- B -- O -- O -- O ($oldrev)"

380 echo " \\"

381 echo " N -- N -- N ($newrev)"

382 echo ""

383 echo "When this happens we assume that you've already had alert emails for all"

384 echo "of the O revisions, and so we here report only the revisions in the N"

385 echo "branch from the common base, B."

386 fi

387 fi

388

389 echo ""

390 if [ -z "$rewind_only" ]; then

391 echo "Those revisions listed above that are new to this repository have"

392 echo "not appeared on any other notification email; so we list those"

393 echo "revisions in full, below."

394

395 echo ""

396 echo $LOGBEGIN

397 git rev-parse --not --branches | grep -v $(git rev-parse $refname) |

398 git rev-list --reverse --pretty --stdin $oldrev..$newrev

399

400 # XXX: Need a way of detecting whether git rev-list actually

401 # outputted anything, so that we can issue a "no new

402 # revisions added by this update" message

403

404 echo $LOGEND

405 else

406 echo "No new revisions were added by this update."

407 fi

408

409 # The diffstat is shown from the old revision to the new revision.

410 # This is to show the truth of what happened in this change.

411 # There's no point showing the stat from the base to the new

412 # revision because the base is effectively a random revision at this

413 # point - the user will be interested in what this revision changed

414 # - including the undoing of previous revisions in the case of

415 # non-fast forward updates.

416 echo ""

417 echo "Summary of changes:"

418 git diff-tree --stat -p --find-copies-harder $oldrev..$newrev

419 }

420

421 #

422 # Called for the deletion of a branch

423 #

424 generate_delete_branch_email()

425 {

426 echo " was $oldrev"

427 echo ""

428 echo $LOGEND

429 git show -s --pretty=oneline $oldrev

430 echo $LOGEND

431 }

432

433 # --------------- Annotated tags

434

435 #

436 # Called for the creation of an annotated tag

437 #

438 generate_create_atag_email()

439 {

440 echo " at $newrev ($newrev_type)"

441

442 generate_atag_email

443 }

444

445 #

446 # Called for the update of an annotated tag (this is probably a rare event

447 # and may not even be allowed)

448 #

449 generate_update_atag_email()

450 {

451 echo " to $newrev ($newrev_type)"

452 echo " from $oldrev (which is now obsolete)"

453

454 generate_atag_email

455 }

456

457 #

458 # Called when an annotated tag is created or changed

459 #

460 generate_atag_email()

461 {

462 # Use git for-each-ref to pull out the individual fields from the

463 # tag

464 eval $(git for-each-ref --shell --format='

465 tagobject=%(*objectname)

466 tagtype=%(*objecttype)

467 tagger=%(taggername)

468 tagged=%(taggerdate)' $refname

469 )

470

471 echo " tagging $tagobject ($tagtype)"

472 case "$tagtype" in

473 commit)

474

475 # If the tagged object is a commit, then we assume this is a

476 # release, and so we calculate which tag this tag is

477 # replacing

478 prevtag=$(git describe --abbrev=0 $newrev^ 2>/dev/null)

479

480 if [ -n "$prevtag" ]; then

481 echo " replaces $prevtag"

482 fi

483 ;;

484 *)

485 echo " length $(git cat-file -s $tagobject) bytes"

486 ;;

487 esac

488 echo " tagged by $tagger"

489 echo " on $tagged"

490

491 echo ""

492 echo $LOGBEGIN

493

494 # Show the content of the tag message; this might contain a change

495 # log or release notes so is worth displaying.

496 git cat-file tag $newrev | sed -e '1,/^$/d'

497

498 echo ""

499 case "$tagtype" in

500 commit)

501 # Only commit tags make sense to have rev-list operations

502 # performed on them

503 if [ -n "$prevtag" ]; then

504 # Show changes since the previous release

505 git rev-list --pretty=short "$prevtag..$newrev" | git shortlog

506 else

507 # No previous tag, show all the changes since time

508 # began

509 git rev-list --pretty=short $newrev | git shortlog

510 fi

511 ;;

512 *)

513 # XXX: Is there anything useful we can do for non-commit

514 # objects?

515 ;;

516 esac

517

518 echo $LOGEND

519 }

520

521 #

522 # Called for the deletion of an annotated tag

523 #

524 generate_delete_atag_email()

525 {

526 echo " was $oldrev"

527 echo ""

528 echo $LOGEND

529 git show -s --pretty=oneline $oldrev

530 echo $LOGEND

531 }

532

533 # --------------- General references

534

535 #

536 # Called when any other type of reference is created (most likely a

537 # non-annotated tag)

538 #

539 generate_create_general_email()

540 {

541 echo " at $newrev ($newrev_type)"

542

543 generate_general_email

544 }

545

546 #

547 # Called when any other type of reference is updated (most likely a

548 # non-annotated tag)

549 #

550 generate_update_general_email()

551 {

552 echo " to $newrev ($newrev_type)"

553 echo " from $oldrev"

554

555 generate_general_email

556 }

557

558 #

559 # Called for creation or update of any other type of reference

560 #

561 generate_general_email()

562 {

563 # Unannotated tags are more about marking a point than releasing a

564 # version; therefore we don't do the shortlog summary that we do for

565 # annotated tags above - we simply show that the point has been

566 # marked, and print the log message for the marked point for

567 # reference purposes

568 #

569 # Note this section also catches any other reference type (although

570 # there aren't any) and deals with them in the same way.

571

572 echo ""

573 if [ "$newrev_type" = "commit" ]; then

574 echo $LOGBEGIN

575 git show --no-color --root -s --pretty=medium $newrev

576 echo $LOGEND

577 else

578 # What can we do here? The tag marks an object that is not

579 # a commit, so there is no log for us to display. It's

580 # probably not wise to output git cat-file as it could be a

581 # binary blob. We'll just say how big it is

582 echo "$newrev is a $newrev_type, and is $(git cat-file -s $newrev) bytes long."

583 fi

584 }

585

586 #

587 # Called for the deletion of any other type of reference

588 #

589 generate_delete_general_email()

590 {

591 echo " was $oldrev"

592 echo ""

593 echo $LOGEND

594 git show -s --pretty=oneline $oldrev

595 echo $LOGEND

596 }

597

598 send_mail()

599 {

600 if [ -n "$envelopesender" ]; then

601 /usr/sbin/sendmail -t -f "$envelopesender"

602 else

603 # /usr/sbin/sendmail -t

604 /home/BIPFS/shaberman/local/bin/msmtp --file=/srv/git/hooks/msmtp.conf -t

605 fi

606 }

607

608 # ---------------------------- main()

609

610 # --- Constants

611 LOGBEGIN="- Log -----------------------------------------------------------------"

612 LOGEND="-----------------------------------------------------------------------"

613

614 # --- Config

615 # Set GIT_DIR either from the working directory, or from the environment

616 # variable.

617 GIT_DIR=$(git rev-parse --git-dir 2>/dev/null)

618 if [ -z "$GIT_DIR" ]; then

619 echo >&2 "fatal: post-receive: GIT_DIR not set"

620 exit 1

621 fi

622

623 projectdesc=$(sed -ne '1p' "$GIT_DIR/description")

624 # Check if the description is unchanged from it's default, and shorten it to

625 # a more manageable length if it is

626 if expr "$projectdesc" : "Unnamed repository.*$" >/dev/null

627 then

628 projectdesc="UNNAMED PROJECT"

629 fi

630

631 recipients=$(git config hooks.mailinglist)

632 announcerecipients=$(git config hooks.announcelist)

633 envelopesender=$(git config hooks.envelopesender)

634 emailprefix=$(git config hooks.emailprefix || echo '[SCM] ')

635

636 # --- Main loop

637 # Allow dual mode: run from the command line just like the update hook, or

638 # if no arguments are given then run as a hook script

639 if [ -n "$1" -a -n "$2" -a -n "$3" ]; then

640 # Output to the terminal in command line mode - if someone wanted to

641 # resend an email; they could redirect the output to sendmail

642 # themselves

643 PAGER= generate_email $2 $3 $1

644 else

645 while read oldrev newrev refname

646 do

647 generate_email $oldrev $newrev $refname | send_mail

648 done

649 fi