From 1815096a37550854829adf631d4c87b4f20b66cc Mon Sep 17 00:00:00 2001 From: Sandro Santilli Date: Tue, 17 Jun 2014 10:43:49 +0200 Subject: [PATCH] Move in-place upgrade of functions from README to CONTRIBUTING --- CONTRIBUTING | 24 ++++++++++++++++++++++++ README.md | 18 ++---------------- 2 files changed, 26 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING b/CONTRIBUTING index adbd73a..16843cc 100644 --- a/CONTRIBUTING +++ b/CONTRIBUTING @@ -35,3 +35,27 @@ Writing testcases Tests reside in the test/ directory. You can find information about how to write tests in test/README + +Testing changes live +-------------------- + +Testing changes made during development requires upgrading +the extension into your test database. + +During development the cartodb extension version doesn't change with +every commit, so testing latest change requires cheating with PostgreSQL +so to enforce re-load of the scripts. To help with cheating, "make install" +also installs migration scripts to go from "V" to "V"next and from "V"next +to "V". Example to upgrade a 0.2.0dev version: + +```sql +ALTER EXTENSION cartodb UPDATE TO '0.2.0devnext'; +ALTER EXTENSION cartodb UPDATE TO '0.2.0dev'; +``` + +Starting with 0.2.0, the in-place reload can be done with an ad-hoc function: + +```sql +SELECT cartodb.cdb_extension_reload(); +``` + diff --git a/README.md b/README.md index 698f16e..83d8637 100644 --- a/README.md +++ b/README.md @@ -87,19 +87,5 @@ ls `pg_config --sharedir`/extension/cartodb* ``` During development the cartodb extension version doesn't change with -every commit, so testing latest change requires cheating with PostgreSQL -so to enforce re-load of the scripts. To help with cheating, "make install" -also installs migration scripts to go from "V" to "V"next and from "V"next -to "V". Example to upgrade a 0.2.0dev version: - -```sql -ALTER EXTENSION cartodb UPDATE TO '0.2.0devnext'; -ALTER EXTENSION cartodb UPDATE TO '0.2.0dev'; -``` - -Starting with 0.2.0, the in-place reload can be done with an ad-hoc function: - -```sql -SELECT cartodb.cdb_extension_reload(); -``` - +every commit, so testing latest change requires special steps documented +in the CONTRIBUTING document, under "Testing changes live".