contrib/devtools/README.md

   1 Contents
   2 ===========
   3 This directory contains tools for developers working on this repository.
   4
   5 github-merge.sh
   6 ----------------
   7
   8 A small script to automate merging pull-requests securely and sign them with GPG.
   9
  10 For example:
  11
  12   ./github-merge.sh bitcoin/bitcoin 3077
  13
  14 (in any git repository) will help you merge pull request #3077 for the
  15 bitcoin/bitcoin repository.
  16
  17 What it does:
  18 * Fetch master and the pull request.
  19 * Locally construct a merge commit.
  20 * Show the diff that merge results in.
  21 * Ask you to verify the resulting source tree (so you can do a make
  22 check or whatever).
  23 * Ask you whether to GPG sign the merge commit.
  24 * Ask you whether to push the result upstream.
  25
  26 This means that there are no potential race conditions (where a
  27 pullreq gets updated while you're reviewing it, but before you click
  28 merge), and when using GPG signatures, that even a compromised github
  29 couldn't mess with the sources.
  30
  31 Setup
  32 ---------
  33 Configuring the github-merge tool for the bitcoin repository is done in the following way:
  34
  35     git config githubmerge.repository bitcoin/bitcoin
  36     git config githubmerge.testcmd "make -j4 check" (adapt to whatever you want to use for testing)
  37     git config --global user.signingkey mykeyid (if you want to GPG sign)
  38