h3 3.4.4 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f9855fbbfa15205895e0467ef2561ec63580395d72c2cacf535c727dfca25e41
-  data.tar.gz: 2b92de2e824682fcaee25176007799203afb24180da11cac5d63d463d3649e90
+  metadata.gz: 95994576b5df069470128bda24d6768b3c8d5fe9ee61ebf0b5f4f16126f64208
+  data.tar.gz: a439783870113f4101d00a3fb94c8f4fec978ddabc55410531aa3e0f3c787fdd
 SHA512:
-  metadata.gz: '08630f598e940bd5f28f86292de45c50a84ac8bcd6965fd406b52cba745d825d8c3fcd18bf687831785a087f2a461a63c230b2a8bd599d26e2c9199c6516f4e3'
-  data.tar.gz: aa9fb82ed82cda98c56d75d89240cc556ca9568562d791aceaee5df084bb95b050c1d314a157d53a400020b25516ea86cf14f5e2ad18b56a0e74af4b67768aa9
+  metadata.gz: 6315cd5682f58cf7384b67fbf8dd4cba4eaa59ccbede04386a94d526b26d593dd0a92df2c4446dc5ff3a662622acbede640d63bae7345c64be0225b92c81d244
+  data.tar.gz: 9b543348c2c66cc8a441ba42e27503d8ace2b83b6714b577e5531a1cb29cb28810a5e816b90adda4a344a2082ed6e4623a25f10b7126a648498fe200787b930e

data/CHANGELOG.md

@@ -6,6 +6,16 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 We track the MAJOR and MINOR version levels of Uber's H3 project (https://github.com/uber/h3) but maintain independent patch levels so we can make small fixes and non breaking changes.
 
+## [3.5.0] - 2019-7-25
+### Added
+- `h3_faces` and `max_face_count` support (#56)
+### Changed
+- New CMake options to prevent unnecessary building of filter apps and benchmarks.
+
+## [3.4.4] - 2019-6-4
+### Changed
+- Internal h3 bugfixes.
+
 ## [3.4.0] - 2019-1-24
 ### Added
 - `res_0_indexes` and `res_0_index_count` support (#51).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    h3 (3.4.0)
+    h3 (3.5.0)
       ffi (~> 1.9)
       rgeo-geojson (~> 2.1)
 

data/README.md

@@ -2,7 +2,8 @@
 
 ![h3](https://user-images.githubusercontent.com/98526/50283275-48177300-044d-11e9-8337-eba8d3cc88a2.png)
 
-[![Build Status](https://travis-ci.org/StuartApp/h3_ruby.svg?branch=master)](https://travis-ci.org/seanhandley/h3_ruby) [![Maintainability](https://api.codeclimate.com/v1/badges/c55e1f67421eba8af8d0/maintainability)](https://codeclimate.com/repos/5c18b7f49bc79a02a4000d81/maintainability) [![Coverage Status](https://coveralls.io/repos/github/StuartApp/h3_ruby/badge.svg?branch=master)](https://coveralls.io/github/StuartApp/h3_ruby?branch=master) [![Gem Version](https://badge.fury.io/rb/h3.svg)](https://badge.fury.io/rb/h3)
+[![Build Status](https://travis-ci.org/StuartApp/h3_ruby.svg?branch=master)](https://travis-ci.org/seanhandley/h3_ruby)
+[![Maintainability](https://api.codeclimate.com/v1/badges/74a47e7fa516588ab545/maintainability)](https://codeclimate.com/repos/5ca38395a86379029800281f/maintainability) [![Coverage Status](https://coveralls.io/repos/github/StuartApp/h3_ruby/badge.svg?branch=master)](https://coveralls.io/github/StuartApp/h3_ruby?branch=master) [![Gem Version](https://badge.fury.io/rb/h3.svg)](https://badge.fury.io/rb/h3)
 
 Ruby-to-C bindings for Uber's [H3 library](https://uber.github.io/h3/).
 

data/ext/h3/Makefile

@@ -1,5 +1,5 @@
 make:
-	cd src; cmake . -DBUILD_SHARED_LIBS=true; make
+	cd src; cmake . -DBUILD_SHARED_LIBS=true -DBUILD_FILTERS=OFF -DBUILD_BENCHMARKS=OFF; make
 install:
 	: # do nothing, we'll load the lib directly
 clean:

data/ext/h3/src/.gitignore

@@ -57,6 +57,7 @@ dev-docs/_build/
 env_docs/
 node_modules/
 website/dist/
+website/package-lock.json
 # Generated Doxyfile
 dev-docs/Doxyfile
 
@@ -98,4 +99,4 @@ KML/res*cells.kml
 KML/res*centers.kml
 
 # Generated files
-src/h3lib/include/h3api.h
+src/h3lib/include/h3api.h

data/ext/h3/src/CHANGELOG.md

@@ -7,6 +7,15 @@ The public API of this library consists of the functions declared in file
 
 ## [Unreleased]
 
+## [3.5.0] - 2019-07-22
+### Added
+- CMake options for excluding filter applications or benchmarks from the build. (#247)
+- `h3GetFaces` function to find icosahedron faces for an index, and helper function `maxFaceCount` (#253)
+### Changed
+- Argument parsing for all filter applications is more flexible. (#238)
+### Fixed
+- Fix printing program name in `h3ToHier` error messages. (#254)
+
 ## [3.4.4] - 2019-05-30
 ### Changed
 - Local coordinate spaces cannot cross more than one icosahedron edge. (#234)

data/ext/h3/src/CMakeLists.txt

@@ -1,4 +1,4 @@
-# Copyright 2017, 2018 Uber Technologies, Inc.
+# Copyright 2017-2019 Uber Technologies, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -29,6 +29,9 @@ set(CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_SOURCE_DIR}/cmake/toolchain.cmake"
     "Toolchain to use for building this project")
 
 option(ENABLE_COVERAGE "Enable compiling tests with coverage." ON)
+option(BUILD_BENCHMARKS "Build benchmarking applications." ON)
+option(BUILD_FILTERS "Build filter applications." ON)
+option(BUILD_GENERATORS "Build code generation applications." ON)
 
 if(WIN32)
     set(SHELL PowerShell -Command)
@@ -117,9 +120,11 @@ set(APP_SOURCE_FILES
     src/apps/applib/include/kml.h
     src/apps/applib/include/benchmark.h
     src/apps/applib/include/utility.h
+    src/apps/applib/include/args.h
+    src/apps/applib/lib/test.c
     src/apps/applib/lib/kml.c
     src/apps/applib/lib/utility.c
-    src/apps/applib/lib/test.c)
+    src/apps/applib/lib/args.c)
 set(EXAMPLE_SOURCE_FILES
     examples/index.c
     examples/distance.c
@@ -149,6 +154,7 @@ set(OTHER_SOURCE_FILES
     src/apps/testapps/testHexRanges.c
     src/apps/testapps/testH3ToGeo.c
     src/apps/testapps/testH3ToChildren.c
+    src/apps/testapps/testH3GetFaces.c
     src/apps/testapps/testGeoCoord.c
     src/apps/testapps/testHexRing.c
     src/apps/testapps/testH3SetToVertexGraph.c
@@ -186,6 +192,8 @@ set(UNCONFIGURED_API_HEADER src/h3lib/include/h3api.h.in)
 set(CONFIGURED_API_HEADER src/h3lib/include/h3api.h)
 configure_file(${UNCONFIGURED_API_HEADER} ${CONFIGURED_API_HEADER})
 
+set(INSTALL_TARGETS h3)
+
 # Build the H3 library
 add_library(h3 ${LIB_SOURCE_FILES} ${CONFIGURED_API_HEADER})
 
@@ -282,6 +290,12 @@ else()
         )
 endif()
 
+# Release publishing
+add_custom_target(update-version
+    COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/scripts/update_version.sh
+    WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+    )
+
 # Website publishing
 add_custom_target(publish-website
     COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/scripts/publish_website.sh
@@ -301,43 +315,58 @@ macro(add_h3_executable name)
     endif()
 endmacro()
 
-add_h3_executable(geoToH3 src/apps/filters/geoToH3.c ${APP_SOURCE_FILES})
-add_h3_executable(h3ToComponents src/apps/filters/h3ToComponents.c ${APP_SOURCE_FILES})
-add_h3_executable(h3ToGeo src/apps/filters/h3ToGeo.c ${APP_SOURCE_FILES})
-add_h3_executable(h3ToLocalIj src/apps/filters/h3ToLocalIj.c ${APP_SOURCE_FILES})
-add_h3_executable(localIjToH3 src/apps/filters/localIjToH3.c ${APP_SOURCE_FILES})
-add_h3_executable(h3ToGeoBoundary src/apps/filters/h3ToGeoBoundary.c ${APP_SOURCE_FILES})
-add_h3_executable(hexRange src/apps/filters/hexRange.c ${APP_SOURCE_FILES})
-add_h3_executable(kRing src/apps/filters/kRing.c ${APP_SOURCE_FILES})
-add_h3_executable(generateBaseCellNeighbors src/apps/miscapps/generateBaseCellNeighbors.c ${APP_SOURCE_FILES})
-add_h3_executable(generateNumHexagons src/apps/miscapps/generateNumHexagons.c ${APP_SOURCE_FILES})
-add_h3_executable(generateFaceCenterPoint src/apps/miscapps/generateFaceCenterPoint.c ${APP_SOURCE_FILES})
-add_h3_executable(h3ToGeoBoundaryHier src/apps/miscapps/h3ToGeoBoundaryHier.c ${APP_SOURCE_FILES})
-add_h3_executable(h3ToGeoHier src/apps/miscapps/h3ToGeoHier.c ${APP_SOURCE_FILES})
-add_h3_executable(h3ToHier src/apps/miscapps/h3ToHier.c ${APP_SOURCE_FILES})
-
-# Generate KML files for visualizing the H3 grid
-add_custom_target(create-kml-dir
-    COMMAND ${CMAKE_COMMAND} -E make_directory KML)
-add_custom_target(kml)
-
-# Only the first 3 resolution grids are generated. The others can be generated,
-# but the file sizes would be very, very large.
-foreach(resolution RANGE 3)
-    set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "KML/res${resolution}cells.kml")
-    set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "KML/res${resolution}centers.kml")
-    add_custom_target(kml_cells_${resolution}
-        COMMAND ${SHELL} "$<TARGET_FILE:h3ToHier> ${resolution} | $<TARGET_FILE:h3ToGeoBoundary> 1 res${resolution}cells.kml \"Res ${resolution} Cells\" > KML/res${resolution}cells.kml"
-        VERBATIM
-        DEPENDS create-kml-dir)
-    add_custom_target(kml_centers_${resolution}
-        COMMAND ${SHELL} "$<TARGET_FILE:h3ToHier> ${resolution} | $<TARGET_FILE:h3ToGeo> 1 res${resolution}centers.kml \"Res ${resolution} Centers\" > KML/res${resolution}centers.kml"
-        VERBATIM
-        DEPENDS create-kml-dir)
-    add_dependencies(kml
-        kml_cells_${resolution}
-        kml_centers_${resolution})
-endforeach()
+if(BUILD_FILTERS)
+    macro(add_h3_filter name)
+        add_h3_executable(${ARGV})
+        list(APPEND INSTALL_TARGETS ${name})
+    endmacro()
+
+    add_h3_filter(geoToH3 src/apps/filters/geoToH3.c ${APP_SOURCE_FILES})
+    add_h3_filter(h3ToComponents src/apps/filters/h3ToComponents.c ${APP_SOURCE_FILES})
+    add_h3_filter(h3ToGeo src/apps/filters/h3ToGeo.c ${APP_SOURCE_FILES})
+    add_h3_filter(h3ToLocalIj src/apps/filters/h3ToLocalIj.c ${APP_SOURCE_FILES})
+    add_h3_filter(localIjToH3 src/apps/filters/localIjToH3.c ${APP_SOURCE_FILES})
+    add_h3_filter(h3ToGeoBoundary src/apps/filters/h3ToGeoBoundary.c ${APP_SOURCE_FILES})
+    add_h3_filter(hexRange src/apps/filters/hexRange.c ${APP_SOURCE_FILES})
+    add_h3_filter(kRing src/apps/filters/kRing.c ${APP_SOURCE_FILES})
+    add_h3_filter(h3ToGeoBoundaryHier src/apps/miscapps/h3ToGeoBoundaryHier.c ${APP_SOURCE_FILES})
+    add_h3_filter(h3ToGeoHier src/apps/miscapps/h3ToGeoHier.c ${APP_SOURCE_FILES})
+    add_h3_filter(h3ToHier src/apps/miscapps/h3ToHier.c ${APP_SOURCE_FILES})
+
+    # Generate KML files for visualizing the H3 grid
+    add_custom_target(create-kml-dir
+        COMMAND ${CMAKE_COMMAND} -E make_directory KML)
+    add_custom_target(kml)
+
+    # Only the first 3 resolution grids are generated. The others can be generated,
+    # but the file sizes would be very, very large.
+    foreach(resolution RANGE 3)
+        set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "KML/res${resolution}cells.kml")
+        set_property(DIRECTORY APPEND PROPERTY ADDITIONAL_MAKE_CLEAN_FILES "KML/res${resolution}centers.kml")
+        add_custom_target(kml_cells_${resolution}
+            COMMAND ${SHELL} "$<TARGET_FILE:h3ToHier> ${resolution} | $<TARGET_FILE:h3ToGeoBoundary> 1 res${resolution}cells.kml \"Res ${resolution} Cells\" > KML/res${resolution}cells.kml"
+            VERBATIM
+            DEPENDS create-kml-dir)
+        add_custom_target(kml_centers_${resolution}
+            COMMAND ${SHELL} "$<TARGET_FILE:h3ToHier> ${resolution} | $<TARGET_FILE:h3ToGeo> 1 res${resolution}centers.kml \"Res ${resolution} Centers\" > KML/res${resolution}centers.kml"
+            VERBATIM
+            DEPENDS create-kml-dir)
+        add_dependencies(kml
+            kml_cells_${resolution}
+            kml_centers_${resolution})
+    endforeach()
+endif()
+
+if(BUILD_GENERATORS)
+    # Code generation
+    add_h3_executable(generateBaseCellNeighbors src/apps/miscapps/generateBaseCellNeighbors.c ${APP_SOURCE_FILES})
+    add_h3_executable(generateNumHexagons src/apps/miscapps/generateNumHexagons.c ${APP_SOURCE_FILES})
+    add_h3_executable(generateFaceCenterPoint src/apps/miscapps/generateFaceCenterPoint.c ${APP_SOURCE_FILES})
+
+    # Miscellaneous testing applications - generating random data
+    add_h3_executable(mkRandGeo src/apps/testapps/mkRandGeo.c ${APP_SOURCE_FILES})
+    add_h3_executable(mkRandGeoBoundary src/apps/testapps/mkRandGeoBoundary.c ${APP_SOURCE_FILES})
+endif()
 
 if(BUILD_TESTING)
     option(PRINT_TEST_FILES "Print which test files correspond to which tests" OFF)
@@ -463,6 +492,7 @@ if(BUILD_TESTING)
     add_h3_test(testHexRanges src/apps/testapps/testHexRanges.c)
     add_h3_test(testH3ToParent src/apps/testapps/testH3ToParent.c)
     add_h3_test(testH3ToChildren src/apps/testapps/testH3ToChildren.c)
+    add_h3_test(testH3GetFaces src/apps/testapps/testH3GetFaces.c)
     add_h3_test(testMaxH3ToChildrenSize src/apps/testapps/testMaxH3ToChildrenSize.c)
     add_h3_test(testH3Index src/apps/testapps/testH3Index.c)
     add_h3_test(testH3Api src/apps/testapps/testH3Api.c)
@@ -487,11 +517,9 @@ if(BUILD_TESTING)
     add_h3_test_with_arg(testH3NeighborRotations src/apps/testapps/testH3NeighborRotations.c 0)
     add_h3_test_with_arg(testH3NeighborRotations src/apps/testapps/testH3NeighborRotations.c 1)
     add_h3_test_with_arg(testH3NeighborRotations src/apps/testapps/testH3NeighborRotations.c 2)
+endif()
 
-    # Miscellaneous testing applications
-    add_h3_executable(mkRandGeo src/apps/testapps/mkRandGeo.c ${APP_SOURCE_FILES})
-    add_h3_executable(mkRandGeoBoundary src/apps/testapps/mkRandGeoBoundary.c ${APP_SOURCE_FILES})
-
+if(BUILD_BENCHMARKS)
     # Benchmarks
     add_custom_target(benchmarks)
 
@@ -552,8 +580,7 @@ configure_package_config_file(
 #   * headers can be included by C++ code `#include <h3/h3api.h>`
 # Installing the library and filters system-wide.
 install(
-    TARGETS h3 geoToH3 h3ToComponents h3ToGeo h3ToGeoBoundary hexRange
-            kRing h3ToGeoBoundaryHier h3ToGeoHier h3ToHier
+    TARGETS ${INSTALL_TARGETS}
     EXPORT "${TARGETS_EXPORT_NAME}"
     LIBRARY DESTINATION "lib"
     ARCHIVE DESTINATION "lib"

data/ext/h3/src/RELEASE.md

@@ -1,8 +1,9 @@
 # Release Process
 
 1. Create a PR "Preparing for release X.Y.Z" against master branch
-    * Update VERSION to `X.Y.Z`
     * Alter CHANGELOG.md from `[Unreleased]` to `[X.Y.Z] YYYY-MM-DD`
+    * Run `make update-version` and give `X.Y.Z` when prompted
+    * Check that all merges that need to be in the changelog are present
 
 2. Create a release "Release X.Y.Z" on Github
     * Create Tag `vX.Y.Z`

data/ext/h3/src/VERSION

@@ -1 +1 @@
-3.4.4
+3.5.0

data/ext/h3/src/docs/api/hierarchy.md

@@ -1,5 +1,7 @@
 # Hierarchical grid functions
 
+These functions permit moving between resolutions in the H3 grid system. The functions produce parent (coarser) or children (finer) cells.
+
 ## h3ToParent
 
 ```

data/ext/h3/src/docs/api/indexing.md

@@ -1,12 +1,14 @@
 # Indexing functions
 
+These function are used for finding the H3 index containing coordinates, and for finding the center and boundary of H3 indexes.
+
 ## geoToH3
 
 ```
 H3Index geoToH3(const GeoCoord *g, int res);
 ```
 
-Indexes the location at the specified resolution.
+Indexes the location at the specified resolution, returning the index of the cell containing the location.
 
 Returns 0 on error.
 

data/ext/h3/src/docs/api/inspection.md

@@ -1,5 +1,7 @@
 # Index inspection functions
 
+These functions provide metadata about an H3 index, such as its resolution or base cell, and provide utilities for converting into and out of the 64-bit representation of an H3 index.
+
 ## h3GetResolution
 
 ```
@@ -57,3 +59,21 @@ int h3IsPentagon(H3Index h);
 ```
 
 Returns non-zero if this index represents a pentagonal cell.
+
+## h3GetFaces
+
+```
+void h3GetFaces(H3Index h, int* out);
+```
+
+Find all icosahedron faces intersected by a given H3 index and places them in the array `out`. `out` must be at least of length `maxFaceCount(h)`.
+
+Faces are represented as integers from 0-19, inclusive. The array is sparse, and empty (no intersection) array values are represented by -1.
+
+### maxFaceCount
+
+```
+int maxFaceCount(H3Index h3);
+```
+
+Returns the maximum number of icosahedron faces the given H3 index may intersect.

data/ext/h3/src/docs/api/misc.md

@@ -1,5 +1,7 @@
 # Miscellaneous H3 functions
 
+These functions include descriptions of the H3 grid system.
+
 ## degsToRads
 
 ```

data/ext/h3/src/docs/api/regions.md

@@ -1,5 +1,7 @@
 # Region functions
 
+These functions convert H3 indexes to and from polygonal areas.
+
 ## polyfill
 
 ```

data/ext/h3/src/docs/api/traversal.md

@@ -1,5 +1,7 @@
 # Grid traversal functions
 
+Grid traversal allows finding cells in the vicinity of an origin cell, and determining how to traverse the grid from one cell to another.
+
 ## kRing
 
 ```

data/ext/h3/src/docs/api/uniedge.md

@@ -1,5 +1,7 @@
 # Unidirectional edge functions
 
+Unidirectional edges allow encoding the directed edge from one cell to a neighboring cell.
+
 ## h3IndexesAreNeighbors
 
 ```

data/ext/h3/src/docs/community/bindings.md

@@ -6,6 +6,10 @@ As a C library, bindings can be made to call H3 functions from different program
 
 - [entrepreneur-interet-general/h3.standard](https://github.com/entrepreneur-interet-general/H3.Standard)
 
+## ClickHouse
+
+- [geoToH3 function, since version 19.11](https://github.com/yandex/ClickHouse/blob/master/dbms/src/Functions/geoToH3.cpp#L35)
+
 ## ECL
 
 - [hpcc-systems/HPCC-Platform](https://github.com/hpcc-systems/HPCC-Platform/tree/master/plugins/h3)

data/ext/h3/src/docs/community/tutorials.md

@@ -2,6 +2,18 @@
 
 This page lists further learning materials and code walkthroughs for the H3 library and bindings. Contributions to this list are welcome, please feel free to open a [pull request](https://github.com/uber/h3/tree/master/docs/community/tutorials.md).
 
+## Videos
+
+- [Introduction to H3](https://www.youtube.com/watch?v=wDuKeUkNLkQ) (June 2019)
+- [Engineering an H3-based Geospatial Data Platform at Uber](https://www.youtube.com/watch?v=aCj-YVZ0mlE)
+- [Building City Cores with H3](https://www.youtube.com/watch?v=PutOhe8HVNU)
+- [H3-js: Hexagons in the Browser](https://www.youtube.com/watch?v=BsMIrBHLfLE&list=PLLEUtp5eGr7CNf9Bj3w3i30rzaU8lKZeV&index=16&t=0s)
+- [Hexagon Convolution for Data Smoothing & Forecasting](https://www.youtube.com/watch?v=z3PaGIQTFSE&list=PLLEUtp5eGr7CNf9Bj3w3i30rzaU8lKZeV&index=14&t=0s)
+- [Spatial Intelligence Using Hex](https://www.youtube.com/watch?v=0OlIpNAqokQ&list=PLLEUtp5eGr7CNf9Bj3w3i30rzaU8lKZeV&index=18&t=0s)
+- [Hierarchical Hexagons in Depth](https://www.youtube.com/watch?v=UILoSqvIM2w&list=PLLEUtp5eGr7CNf9Bj3w3i30rzaU8lKZeV&index=15&t=0s)
+- [H3: Tiling the Earth with Hexagons](https://www.youtube.com/watch?v=_-265mfMzl4&list=PLLEUtp5eGr7CNf9Bj3w3i30rzaU8lKZeV&index=22&t=0s) (Introduction to H3, November 2018)
+- [H3: Tiling the Earth with Hexagons](https://www.youtube.com/watch?v=ay2uwtRO3QE) (Introduction to H3, January 2018)
+
 ## Java
 
 - [H3 Measurements](https://github.com/isaacbrodsky/h3measurements): Measurements of average cell area, average cell perimeter length, truncation error, and so on.

data/ext/h3/src/scripts/update_version.sh

@@ -0,0 +1,50 @@
+#!/bin/bash
+# Copyright 2019 Uber Technologies, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# This script is used interactively as part of the H3 release process 
+# (RELEASE.md) to update the version number in the VERSION file. Before
+# writing the new version to the file, changelog information is presented
+# for verification. It is invoked by the make target `update-version`.
+
+set -eo pipefail
+
+CURRENT_VERSION=$(<VERSION)
+echo "Current version: $CURRENT_VERSION"
+CURRENT_TAG="v$CURRENT_VERSION"
+
+if ! git rev-parse $CURRENT_TAG -- > /dev/null 2>&1; then
+    echo "Could not locate $CURRENT_TAG as a Git revision."
+    exit 1
+fi
+
+REVISION_RANGE="$CURRENT_TAG..HEAD"
+
+read -p "Next version: " NEXT_VERSION
+
+echo -e "\n * Changelog entries *"
+git diff $REVISION_RANGE -- CHANGELOG.md
+echo -e "\n * Committed merges *"
+git log --merges --oneline $REVISION_RANGE
+
+echo
+read -p "Are all changes in the changelog [y/N]? " CHANGELOG_OK
+if [ "y" = "$CHANGELOG_OK" ] || [ "Y" = "$CHANGELOG_OK" ]; then
+    echo $NEXT_VERSION > VERSION
+    echo "Wrote $NEXT_VERSION to the VERSION file"
+else
+    echo "Cancelled - did not write VERSION file"
+    echo "Please update the CHANGELOG with the appropriate entries before bumping the version."
+    exit 2
+fi