From 274da8930804b2187568423c3bfeed541f235001 Mon Sep 17 00:00:00 2001 From: Théo Zimmermann Date: Mon, 26 Mar 2018 15:55:46 +0200 Subject: Some advice about merge script dependencies. Including: how to create a GPG key. --- dev/doc/MERGING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to 'dev') diff --git a/dev/doc/MERGING.md b/dev/doc/MERGING.md index 70d8481887..402ed37bdc 100644 --- a/dev/doc/MERGING.md +++ b/dev/doc/MERGING.md @@ -104,3 +104,14 @@ There are two cases to consider: merge the PR and then notify upstream they can merge the patch. This is a less preferable scenario because it is probably going to create spurious CI failures for unrelated PRs. + +### Merge script dependencies + +The merge script passes option `-S` to `git merge` to ensure merge commits +are signed. Consequently, it depends on the GnuPG command utility being +installed and a GPG key being available. Here is a short tutorial to +creating your own GPG key: + + +The script depends on a few other utilities. If you are a Nix user, the +simplest way of getting them is to run `nix-shell` first. -- cgit v1.2.3