doc(release): add osx required notes and a missing step
@@ -45,6 +45,28 @@ $ git config [--global] user.signingkey "$GPG_KEY_ID"
$ git config [--global] user.email "$GPG_EMAIL"
```
+Also, make sure that you setup the git gpg config as follows.
+```bash
+$ cat ~/.gnupg/gpg.conf
+default-key $GPG_KEY_ID
+```
+
+**NOTE** If you do a release from an OSX machine, you need to configure `gnu-gpg` to sign the release's tag:
+- Install the requirements by running: `brew install gpg2 gnupg pinentry-mac`
+- Append the following to your ~/.bash_profile or ~/.bashrc or ~/.zshrc
+```
+export GPG_TTY=`tty`
+```
+- Restart your Terminal or source your ~/.*rc file
+- Then, make sure git uses gpg2 and not gpg
+```bash
+$ git config --global gpg.program gpg2
+```
+- To make sure gpg2 itself is working
+```bash
+$ echo "test" | gpg2 --clearsign
+```
+
## GitHub release information
### Locking down branches
@@ -216,6 +238,8 @@ Call the script with the only argument being the new SDK version:
$ ./release.sh v1.3.0
```
+**NOTE** The `./release.sh` script requires `GNU sed` and the `GNU make` instead of the default installed sed. Install them with: `brew install gnu-sed` and `brew install make`, then ensure they are present in your `$PATH`.
+
Release binaries and signatures will be in `build/`. Both binary and signature file names contain version, architecture, and platform information; signature file names correspond to the binary they were generated from suffixed with `.asc`. For example, signature file `operator-sdk-v1.3.0-x86_64-apple-darwin.asc` was generated from a binary named `operator-sdk-v1.3.0-x86_64-apple-darwin`. To verify binaries and tags, see the [verification section](#verifying-a-release).
**Note:** you must have both [`git`][doc-git-default-key] and [`gpg`][doc-gpg-default-key] default PGP keys set locally for `release.sh` to run without error. Additionally you must add your PGP key to a [public-key-server](#release-signing).
