Skip to content

Commit

Permalink
Updates for release process notes (#128)
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacbrodsky committed Feb 6, 2023
1 parent f3a233e commit c8e738f
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 10 deletions.
3 changes: 3 additions & 0 deletions CHANGELOG.md
Expand Up @@ -7,6 +7,9 @@ file [H3Core.java](./src/main/java/com/uber/h3core/H3Core.java), and support
for the Linux x64 and Darwin x64 platforms.

## Unreleased Changes
## [4.1.1] - 2023-02-03
The changelog for this release is the same as v4.1.0. The release was run again due to an issue with the release process.

## [4.1.0] - 2023-01-19
### Added
- `cellToChildPos` and `childPosToCell` functions. (#121)
Expand Down
11 changes: 11 additions & 0 deletions docs/DEVELOPERS-README.md
@@ -1,3 +1,14 @@
# H3-Java Developer Documentation

This directory contains documentation for building and integrating H3-Java.

## Troubleshooting

### docker: Error response from daemon: error while creating mount source path

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.

### fatal error: jni.h: No such file or directory

This can occur when `JAVA_HOME` is not set.

12 changes: 2 additions & 10 deletions docs/releasing.md
Expand Up @@ -4,9 +4,9 @@ The H3-Java library is published to Maven Central via OSSRH.

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).

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.
Release builds pull artifacts from Github Actions. This is needed so that the deployed artifact contains all supported operating system/architecture combinations. (In particular, Mac OS artifacts must be built natively.) In order to release, there must be a completed build of the Git commit to release on Github. The build must be less than 30 days old, as artifacts are only kept for that time.

1. Ensure you are on branch `master` and that the library is building correctly.
1. Ensure you are on branch `master` and that the library is building correctly in Github Actions.
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.
3. `mvn release:prepare` Use the new version number when prompted.
4. `mvn release:perform`
Expand All @@ -27,11 +27,3 @@ Per [StackOverflow](https://stackoverflow.com/questions/57591432/gpg-signing-fai
```
export GPG_TTY=$(tty)
```

### docker: Error response from daemon: error while creating mount source path

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.

### fatal error: jni.h: No such file or directory

This can occur when `JAVA_HOME` is not set.

0 comments on commit c8e738f

Please sign in to comment.