Add some docs for release procedures and manual tests.

2 files changed, 45 insertions, 0 deletions

diff --git a/release_procedure.txt b/release_procedure.txt
new file mode 100644
index 00000000..3fa327a7
--- /dev/null
+++ b/release_procedure.txt
@@ -0,0 +1,14 @@
+# vi: ft=vimwiki
+
+* Bump the version number in pgcli/__init__.py
+* Commit with message: 'Releasing version X.X.X.'
+* Create a tag: git tag vX.X.X
+* Register with pypi for new version: python setup.py register
+* Fix the image url in PyPI to point to github raw content. https://raw.githubusercontent.com/amjith/pgcli/master/screenshots/image01.png
+* Create source dist tar ball: python setup.py sdist
+* Test this by installing it in a fresh new virtualenv. Run SanityChecks [./sanity_checks.txt].
+* Upload the source dist to PyPI: https://pypi.python.org/pypi/pgcli
+* pip install pgcli 
+* Run SanityChecks.
+* Push the version back to github: git push --tags origin master 
+* Done!
diff --git a/sanity_checks.txt b/sanity_checks.txt
new file mode 100644
index 00000000..899c4c9d
--- /dev/null
+++ b/sanity_checks.txt
@@ -0,0 +1,31 @@
+# vi: ft=vimwiki
+
+* Launch pgcli with different inputs. 
+    * pgcli test_db
+    * pgcli postgres://localhost/test_db
+    * pgcli postgres://localhost:5432/test_db
+    * pgcli postgres://amjith@localhost:5432/test_db
+    * pgcli postgres://amjith:password@localhost:5432/test_db
+    * pgcli non-existent-db
+
+* Test special command
+    * \d
+    * \d table_name
+    * \dt
+    * \l 
+    * \c amjith 
+    * \q
+
+* Test smart-completion
+    * Sele - Must auto-complete to SELECT
+    * SELECT * FROM  - Must list the table names.
+    * INSERT INTO - Must list table names.
+    * \d <tab> - Must list table names.
+    * \c <tab> - Database names.
+    * SELECT * FROM table_name WHERE <tab> - column names (all of it).
+
+* Test naive-completion - turn off smart completion (using F2 key after launch)
+    * Sele - autocomplete to select. 
+    * SELECT * FROM - autocomplete list should have everything. 
+
+