Merge pull request #117 from akesterson/bugfix/travis_deployment

Fix akesterson's stored password in travis-ci, add instructions for cutting a new release

Author: calebcase

.travis.yml

@@ -2,16 +2,15 @@ deploy:
   provider: pypi
   user: akesterson
   password:
-    secure: H0XRotyZm7xxpkR5bTxyjWSnwrUQUscKIj9Miqn9l1aROZN3GQ4oLLP8Epa590UQ/VLSlKQ28oalejlbDHG452K1726NAytO3r/0Oy/htuBf5DoR3VCa+aivOjeCVd2Axgc0385BB2ouG8aYJOL7Lc0sJ9fFUG7pQ2f3lZlzZLo=
-  on:
+    secure: RlZ3kw0x7/5QNBUIqj5wjkpS11TuSdH7o1S41m4Vea8HiryQjB2+CFf+uBXj8nb1OtYDRaeKTSnk3qVlUvaUglFd7sV+Hh2DDo4pYomd0xDFHnK2LB+hzbYftkOptmwdS2bc0X7vr+xdY+7b2DPTlyowrs3Xp2WvzRWM4hWnA3Q=
+  true:
     tags: true
     branch: master
-
 sudo: false
 language: python
 python:
-  - "3.6"
-  - "3.8"
-  - "pypy3"
+- '3.6'
+- '3.8'
+- pypy3
 install: travis_retry pip install tox-travis
 script: tox

MAINTAINERS.md

@@ -74,4 +74,45 @@ The more complete process goes:
 4. Create a fork of dpath-python, and name your branch for the work. We name bugfixes as "bugfix/ISSUENUMBER_shortname"; features are named "feature/ISSUENUMBER_shortname".
 5. Complete and push your work on your fork. Use tox to test your work against the test suites. Features MUST ship with at least one new unit test that covers the new functionality. Bugfixes MUST ship with one new test (or an updated old test) that guards against regression.
 6. Send your pull request
-7. If accepted, the maintainers will merge your pull request and close the issue.
+7. If accepted, the maintainers will merge your pull request and close the issue.
+
+
+Cutting a New Release
+=====================
+
+Releases for dpath occur automatically from travis-ci based on tags on the master branch.
+
+    akesterson@akesterson:~/dpath-python$ git tag
+    1.0-0
+    1.1
+    1.2-66
+    1.2-68
+    1.2-70
+    build,1.2,70
+    build,1.2,71
+    build,1.2,72
+    build,1.3,0
+    build,1.3,1
+    build,1.3,2
+    build,1.3,3
+    build,1.4,0
+    build,1.4,1
+    build,1.4,3
+    build,1.5,0
+    build,2.0,0
+
+Once upon a time, the version string was automatially computed based on the content of these tags. Now, however, the version string is stored statically in dpath/version.py
+
+    akesterson@akesterson:~/dpath-python$ cat dpath/version.py
+    VERSION = "2.0.0"
+
+To cut a new release, follow this procedure:
+
+1. Commit a new dpath/version.py on the master branch with the format "MAJOR.MINOR.RELEASE"
+2. Add a new tag of the form "build,MAJOR.MINOR,RELEASE" to the master branch. This tag must have the same version number as the one commmited in dpath/version.py or we will fill your desk drawers with cockroaches.
+3. Push the new master version and the associated tag to github.
+4. travis-ci SHOULD push the new release to pypi.
+
+If travis-ci fails to update pypi, follow the instructions on manually creating a release, here:
+
+https://packaging.python.org/tutorials/packaging-projects/#uploading-the-distribution-archives