diff --git a/README.md b/README.md index 6c23283..51669e6 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,16 @@ The code in this repository is licensed under the MIT license. Have a look at [the steps required to extract and prepare the data](STEPS.md) +### Preparing a new release + +Run this script to generate release assets in `prepare-release/release-assets`: + +`{version}` should be the version tag, e.g. v0.2.0 + +```bash +prepare-release/prepare-release.sh {version} +``` + ## Uses This data is used in the [Q Locator Map Tool](https://github.com/nzzdev/Q-locator-map), @@ -33,15 +43,14 @@ for which a [demo](https://editor.q.tools) is also available. ### Countries (overview) -Screenshot Countries +Screenshot Countries ### Subdivisions (overview) -Screenshot Subdivisions +Screenshot Subdivisions ### Close-ups -Screenshot Liechtenstein - -Screenshot Appenzell Innerrhoden +Screenshot Liechtenstein +Screenshot Appenzell Innerrhoden diff --git a/STEPS.md b/STEPS.md index 47f5172..2d8fec6 100644 --- a/STEPS.md +++ b/STEPS.md @@ -16,7 +16,7 @@ Landing page: https://osmdata.openstreetmap.de/data/land-polygons.html You may want to open the file in mapshaper and check that the polygons do not self-intersect, because clipping with self-intersecting polygons will corrupt data. For example, clipping with these polygons removes most of Japan from the output: -Screenshot +Screenshot You can also use [this snapshot of land polygons](https://nzz-q-assets-stage.s3.amazonaws.com/q-locator-map/land-polygons-complete-4326_2019-11-18.zip) @@ -38,6 +38,16 @@ Direct links: Landing page: https://www.naturalearthdata.com/downloads/10m-cultural-vectors/ +## Dependencies + +Run + +```bash +npm install +``` + +to install the dependencies. + ## Steps Run this script to execute all steps listed below: diff --git a/prepare-release/.gitignore b/prepare-release/.gitignore new file mode 100644 index 0000000..a882893 --- /dev/null +++ b/prepare-release/.gitignore @@ -0,0 +1 @@ +/release-assets diff --git a/prepare-release/copyright-notice/README.txt b/prepare-release/copyright-notice/README.txt new file mode 100644 index 0000000..79e001d --- /dev/null +++ b/prepare-release/copyright-notice/README.txt @@ -0,0 +1,9 @@ +Downloaded from https://github.com/nzzdev/osm-regions + +LICENSE +======= + +This data is Copyright 2020 OpenStreetMap contributors. It is +available under the Open Database License (ODbL). + +For more information see https://www.openstreetmap.org/copyright diff --git a/prepare-release/prepare-release.sh b/prepare-release/prepare-release.sh new file mode 100755 index 0000000..c98bf4c --- /dev/null +++ b/prepare-release/prepare-release.sh @@ -0,0 +1,54 @@ +#!/bin/bash +set -o errexit +set -o nounset + +if [ "$#" -lt 1 ]; then + echo "Version argument is missing." + exit 1 +fi +version="$1" + +import_osm_root=$(dirname "$0")/../import-osm +release_assets=$(dirname "$0")/release-assets +readme=$(dirname "$0")/copyright-notice/README.txt + +rm -rf "$release_assets" +mkdir -p "$release_assets" + +### +# Inputs +### + +# land-polygons-complete-4326 => osmdata-land-polygons-{version}.zip +zip --junk-paths \ + "$release_assets"/osmdata-land-polygons-"$version".zip \ + "$import_osm_root"/00-static-data/land-polygons-complete-4326/* + + +### +# Ouputs +### + +# Q{###}.json => simplified-regions-{version}.zip +zip --quiet --recurse-paths --junk-paths \ + "$release_assets"/simplified-regions-"$version".zip \ + "$import_osm_root"/06-simplify-regions/output \ + "$readme" + +# countries-clipped.json => countries-geojson-{version}.zip +zip --junk-paths \ + "$release_assets"/countries-geojson-"$version".zip \ + "$import_osm_root"/07-merge-regions/output/countries-clipped.json \ + "$readme" + +# subdivisions-clipped.json => subdivisions-geojson-{version}.zip +zip --junk-paths \ + "$release_assets"/subdivisions-geojson-"$version".zip \ + "$import_osm_root"/07-merge-regions/output/subdivisions-clipped.json \ + "$readme" + +# regions.mbtiles => regions-mbtiles-{version}.zip +zip --junk-paths \ + "$release_assets"/regions-mbtiles-"$version".zip \ + "$import_osm_root"/11-join-tiles/output/regions.mbtiles \ + "$readme" diff --git a/screenshot_Appenzell.png b/screenshots/Appenzell.png similarity index 100% rename from screenshot_Appenzell.png rename to screenshots/Appenzell.png diff --git a/screenshot_Liechtenstein.png b/screenshots/Liechtenstein.png similarity index 100% rename from screenshot_Liechtenstein.png rename to screenshots/Liechtenstein.png diff --git a/screenshot_countries.png b/screenshots/countries.png similarity index 100% rename from screenshot_countries.png rename to screenshots/countries.png diff --git a/screenshot_mapshaper.png b/screenshots/mapshaper.png similarity index 100% rename from screenshot_mapshaper.png rename to screenshots/mapshaper.png diff --git a/screenshot_subdivisions.png b/screenshots/subdivisions.png similarity index 100% rename from screenshot_subdivisions.png rename to screenshots/subdivisions.png