From 841c529dda833e87fab4d710957921ce7c65c0a3 Mon Sep 17 00:00:00 2001 From: marc tobias Date: Thu, 25 Feb 2021 21:45:56 +0100 Subject: [PATCH] version 3.0.0 --- CHANGES.md | 17 ++++++++++++++--- CONTRIBUTE.md | 9 ++++----- README.md | 2 ++ package.json | 2 +- 4 files changed, 21 insertions(+), 9 deletions(-) diff --git a/CHANGES.md b/CHANGES.md index df3b598..716e369 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -1,8 +1,19 @@ # CHANGES -* unreleased - * Add theming - * Replace config.js with config.default.js and theme/config.theme.js +* version 3.0.0 - 2021-02-25 + + Version 3 add a new directory dist/theme/. It changes the default welcome, about and + help text, and moves the configuration into dist/theme/. Admins should review those + (explained in README.md) before deploying the nominatim-ui. + + * Major change: Add theming + * Major change: Replace dist/config.js with dist/config.default.js and dist/theme/config.theme.js + * Refactored and added API error output + * Build: dist/build/bundle.* files are now created by a Github Action upon release, no longer in version control + * Documentation: removed TODO.md, we use github issues now + * Documentation: README.md is part of the release, moved some development content to CONTRIBUTE.md + * Documentation: badge showing latest release version in README.md + * Documentation: badge showing latest test (Github CI) output in CONTRIBUTE.md * version 2.3.0 - 2021-02-19 diff --git a/CONTRIBUTE.md b/CONTRIBUTE.md index e8c56e3..66251be 100644 --- a/CONTRIBUTE.md +++ b/CONTRIBUTE.md @@ -44,10 +44,9 @@ Uses [svelte](https://svelte.dev/) framework, 2. Update `CHANGES.md` file -3. Run `yarn build` to make sure the `dist/build/` files don't contain lifereload.js +3. Commit your changes: `git add... `, `git commit ...`, `git push ...` etc -4. Commit your changes: `git add... `, `git commit ...`, `git push ...` etc +4. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags` -5. Tag release: `git tag THE_VERSION_NUMBER`, `git push --tags` - -6. Upload release \ No newline at end of file +5. Create release on https://github.com/osm-search/nominatim-ui/releases + This (a triggered Github Action) will run `yarn build` and add the `dist/build/bundle.*` files. diff --git a/README.md b/README.md index 1d4d018..f650882 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,7 @@ # Nominatim-UI +![GitHub release (latest by date)](https://img.shields.io/github/v/release/osm-search/nominatim-ui) + Debugging user interface for [Nominatim](https://nominatim.org/) ([source](https://github.com/osm-search/Nominatim/)) geocoder. diff --git a/package.json b/package.json index f816e09..426cd30 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "nominatim-ui", "description": "Debug web interface for Nominatim geocoder", - "version": "2.3.0", + "version": "3.0.0", "license": "GPL-2.0", "scripts": { "build": "rollup -c", -- 2.39.5