Skip to content

Commit 661bea1

Browse files
authored
Add release troubleshooting steps (#84)
1 parent fbad733 commit 661bea1

File tree

1 file changed

+17
-3
lines changed

1 file changed

+17
-3
lines changed

docs/releasing.md

Lines changed: 17 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,25 @@ The H3-Java library is published to Maven Central via OSSRH.
44

55
You must be a member of the `com.uber` group to release the library via OSSRH. You must have a [signing key](http://central.sonatype.org/pages/working-with-pgp-signatures.html) setup, and you must have your OSSRH username and password in the appropriate [Maven settings file](http://central.sonatype.org/pages/apache-maven.html).
66

7-
Release builds should only be run on Mac OSX with Docker. This is needed so that the deployed artifact contains all supported operating system/architecture combinations. Before deploying, run `mvn clean package` and check that at least the files `src/main/resources/darwin-x64/libh3-java.dylib` and `src/main/resources/linux-x64/libh3-java.so` exist.
7+
Release builds should only be run on Mac OSX with Docker. This is needed so that the deployed artifact contains all supported operating system/architecture combinations. Other architectures are built using cross compiler, but Mac OSX is built natively. Before deploying, run `mvn clean package` and check that at least the files `src/main/resources/darwin-x64/libh3-java.dylib` and `src/main/resources/linux-x64/libh3-java.so` exist.
88

9-
1. Ensure you are on master and that the library is building correctly.
9+
1. Ensure you are on branch `master` and that the library is building correctly.
1010
2. Update [CHANGELOG.md](../CHANGELOG.md) to have the correct date and new version number, update [README.md](../README.md) to have the correct version numbers, and commit.
1111
3. `mvn release:prepare` Use the new version number when prompted.
1212
4. `mvn release:perform`
13-
5. If this looks good, release the build in [Sonatype Nexus Manager](https://oss.sonatype.org/).
13+
5. If this looks good, close and release the build in [Sonatype Nexus Manager](https://oss.sonatype.org/).
1414
6. Update `CHANGELOG.md` to have an Unreleased section, and commit. The release is now done and development can resume from this point.
15+
16+
## Troubleshooting
17+
18+
### gpg: signing failed: Inappropriate ioctl for device
19+
20+
Per [StackOverflow](https://stackoverflow.com/questions/57591432/gpg-signing-failed-inappropriate-ioctl-for-device-on-macos-with-maven), run the following before `mvn release:perform`:
21+
22+
```
23+
export GPG_TTY=$(tty)
24+
```
25+
26+
### docker: Error response from daemon: error while creating mount source path
27+
28+
This has been seen when the source path is not shared from the host in the Docker settings. Even if the source path appears to have been shared, if the source path is a symbolic link, you may need to reshare it from Docker Preferences.

0 commit comments

Comments
 (0)