Merge branch 'upload-latest-release-and-tweak-readme-how-to-make-a-release'

* upload-latest-release-and-tweak-readme-how-to-make-a-release:
  README: Improve "how to make a release ?"
  package: Upload packages to a pre-release named "latest"

Author: jcfr

.travis.yml

@@ -29,6 +29,14 @@ install:
 script:
   - tox
 
+deploy:
+  - provider: script
+    script: scripts/upload-latest-release.sh
+    skip_cleanup: true
+    on:
+      repo: j0057/github-release
+      branch: master
+
 env:
   global:
-    secure: "UmvFiDNU+3kc7Rc3xd/1LsIQx+qhF+Zb1GVxLtLJlBCGUQNX1Fb65sgZSJEEEbIXiM6pxKk3yWAa1bORJhqbhPKMex7y2pTEs8LR7kIyYLrJiMo/wd3jfQhwyJyoRMk8RntDt2dLA1iTRFfb7bjmxf8TAxCf8HgtV1R4ZEJSsdDW3afNjf1sPX7QRKToLWp80dWB9z/Co4LvMVakQiCQmmO7VowpSwSep33CzyHhB4Iy9Q6earakM7zt1kOI0+MTvooCKjvmVIvMI3FgUao2yM9lzORa2QRKifHmgjVkkbmNwBkjk9dgUpRpk/CocHJsSFKG4Pm/hHMjKg1gqNWVtzM1jiCRANEVsfA2er6879xdQr2d4xZ4RCnb/w39+/30+yuxr53x6+pW9qaz2AmqTm249CCjMkTyotXlX6TYQSb7wOiYGV2bQhXFIq5XCjRLlhEPUHWRbJ8QRPIP+aTqMaHY7TH7RDfV3hg09Twd1d361z+qIsTlahhWatffEjiQxIP63PiSTmCjNHm7MZcIdSf7kwOaPjvHSXXRieYZtNXP9v0wQ/pUK/ESPfgxq9RVcZKpWDQ5dToKCc4P8szL08DZU0p/QqK5F8EO1o3h0CzGbVRUsZPixmzJ9t2f2fFn8oTdPuvMak/L9QSGCaKSDtOnAyTuEVXfwMlzQoHbguc="
+    secure: "BBMD+hloyqOsR/0Pac8WRpStkQDi+30ZZgnC4//Wiqpk82FdOfuVBMaQrTnCFeUaqLHBCDm5MMW58s7GjSn/zEPtHoNlvxpW9uV0CRub3pjs+2GsXNTh1gBuFzYohImhTZf1M2VzGT12NnjN0QYqFNoaDkihbC44q1+Mz/qtFDyHT92QgQ9TkbI9vrfJBDAKq5rQgIXqmZNJZGGFmk91XnNri4k4wddIHkZd+sVx398KaAbw8fEZoxLEGedTmKUrLexDB/4Hh1C2XMm+u6CrEou6p6Kk45jho31bEPSqDPcnWadPXsomQ1wr/n1TRxEQZfAxRm3irqshwz7DX8Yw/JLuBf3Y0Y/sqfwRwI8JbR8WuKyzSwclotcdj17FJgsKettyf4WsF/4UrqZKFG2MKrR49GQbOVmFtpDnfFYuZ/be0OptZHXhXKxj8Pbj5RaxvjzXDQVpPyOvWW9fZlGi1DhVsNsiSl4wQyV253P4Tax91mFRog1W4QOf8fkY8bVEU6hhqI8ApntDmXHlT5Ym1zXLqsk+U4maxXPC2NXATD6B778hRP906WCv6dqHVb5fwn06HftdfWrpWTa+Aww470IRbTvC1SSWa4zoD6kHX9rXtP4lEy7yA2E+I65dgY/Heq3ERIkVmjvjulks1HkQWqZeoe7nD58sSSwrxuaIbRo="

CHANGES.md

@@ -63,6 +63,21 @@ Testing
 
 * Relocate test repositories under [github-release-bot](https://github.com/github-release-bot) user.
 
+Build System
+------------
+
+* Latest packages are now published
+
+  * Packages generated from master branch are available at https://github.com/j0057/github-release/releases/tag/latest
+
+  * They can be installed using `pip intall githubrelease -f https://github.com/j0057/github-release/releases/tag/latest`
+
+Documentation
+-------------
+
+* Update [maintainers: how to make a release ?](https://github.com/j0057/github-release/blob/master/README.md#maintainers-how-to-make-a-release-) section
+  to include update of *CHANGES.md* and creation of a [github release](https://github.com/j0057/github-release/releases).
+
 1.5.0
 =====
 
@@ -180,8 +195,8 @@ Build System
 Documentation
 -------------
 
-* Re-organize and improve [README.md](https://github.com/j0057/github-release/tree/add-changes-md#table-of-contents).
+* Re-organize and improve [README.md](https://github.com/j0057/github-release/blob/master/README.md#table-of-contents).
 
-* Add [maintainers: how to make a release ?](https://github.com/j0057/github-release/tree/add-changes-md#maintainers-how-to-make-a-release-) section.
+* Add [maintainers: how to make a release ?](https://github.com/j0057/github-release/blob/master/README.md#maintainers-how-to-make-a-release-) section.
 
 * Add [CONTRIBUTING](https://github.com/j0057/github-release/blob/master/CONTRIBUTING.md#contributing) guidelines.

README.md

@@ -80,10 +80,18 @@ Python, you should probably look into project like [github3py](http://github3py.
 
 # installing
 
+Released stable version can be installed from [pypi](https://pypi.python.org/pypi/githubrelease) using:
+
 ```bash
 pip install githubrelease
 ```
 
+Bleeding edge version can be installed using:
+
+```bash
+pip intall githubrelease -f https://github.com/j0057/github-release/releases/tag/latest
+```
+
 # configuring
 
 First, [generate a new token](https://help.github.com/articles/creating-an-access-token-for-command-line-use). It
@@ -335,41 +343,62 @@ that has already been intercepted and recorded.
 
 2. Make sure the cli and module work as expected
 
-3. Tag the release. Requires a GPG key with signatures. For version *X.Y.Z*::
+3. Review [CHANGES.md](https://github.com/j0057/github-release/blob/master/README.md), replace *Next Release* into *X.Y.Z*, commit and push. Consider using `[ci skip]` in commit message.
+
+4. Tag the release. Requires a GPG key with signatures. For version *X.Y.Z*:
 
     ```bash
     git tag -s -m "githubrelease X.Y.Z" X.Y.Z origin/master
     ```
 
-4. Create the source tarball and binary wheels::
+5. Create the source tarball and binary wheels:
 
     ```bash
     rm -rf dist/
     python setup.py sdist bdist_wheel
     ```
 
-5. Upload the packages to the testing PyPI instance::
+6. Upload the packages to the testing PyPI instance:
 
     ```bash
     twine upload --sign -r pypitest dist/*
     ```
 
-6. Check the [PyPI testing package page](https://testpypi.python.org/pypi/githubrelease/).
+7. Check the [PyPI testing package page](https://testpypi.python.org/pypi/githubrelease/).
 
-7. Upload the packages to the PyPI instance::
+8. Upload the packages to the PyPI instance::
 
     ```bash
     twine upload --sign dist/*
     ```
 
-8. Check the [PyPI package page](https://pypi.python.org/pypi/githubrelease/).
+9. Check the [PyPI package page](https://pypi.python.org/pypi/githubrelease/).
 
-9. Make sure the package can be installed::
+10. Create a virtual env, and make sure the package can be installed:
 
     ```bash
-    mkvirtualenv test-pip-install
+    mkvirtualenv test-githubrelease-install
     pip install githubrelease
-    rmvirtualenv test-pip-install
+    ```
+
+11. Create github release and upload packages:
+
+    ```bash
+    export GITHUB_TOKEN=YOUR_TOKEN
+    githubrelease release j0057/github-release create X.Y.Z --name X.Y.Z --publish ./dist/*
+    ```
+
+12. Update release notes by copying relevant content from CHANGES.md
+
+    ```bash
+    export EDITOR=vim
+    githubrelease release j0057/github-release release-notes X.Y.Z
+    ```
+
+13. Cleanup
+
+    ```bash
+    rmvirtualenv test-githubrelease-install
     ```
 
 # faq

scripts/upload-latest-release.sh

@@ -0,0 +1,44 @@
+#!/usr/bin/env bash
+
+set -ex
+
+if [[ "${TRAVIS}" == "true" ]] && [[ ${TRAVIS_PYTHON_VERSION} != "3.5.2" ]]; then
+  echo "Skipping package on upload on Travis using python != 3.5.2 [TRAVIS_PYTHON_VERSION: ${TRAVIS_PYTHON_VERSION}]"
+  exit 0
+fi
+
+pip install .
+
+REPO_NAME=j0057/github-release
+PRERELEASE_NAME=latest
+PACKAGE_DIR=./dist
+EXPECTED_PACKAGE_COUNT=2
+
+release_date=$(date -u "+%Y-%m-%d at %0k:%M %Z")
+release_name="Latest (updated at ${release_date})"
+
+# Check if packages have been generated
+packages=(${PACKAGE_DIR}/*)
+if [[ ${#packages[@]} -ne ${EXPECTED_PACKAGE_COUNT} ]]; then
+  echo "Error: ${EXPECTED_PACKAGE_COUNT} packages are expected in ${PACKAGE_DIR}"
+  ls ${PACKAGE_DIR}
+  exit 1
+fi
+
+# If needed, create release
+githubrelease --github-token ${GITHUB_UPLOAD_RELEASE_TOKEN} \
+  release ${REPO_NAME} create --prerelease ${PRERELEASE_NAME} --name "${release_name}"
+
+# Remove existing packages
+githubrelease --github-token ${GITHUB_UPLOAD_RELEASE_TOKEN} \
+  asset ${REPO_NAME} delete ${PRERELEASE_NAME} "*"
+
+# Upload latest packages
+githubrelease --github-token ${GITHUB_UPLOAD_RELEASE_TOKEN} \
+  asset ${REPO_NAME} upload ${PRERELEASE_NAME} ${PACKAGE_DIR}/*
+
+# Update release reference and name
+sha=$(git rev-parse HEAD)
+githubrelease --github-token ${GITHUB_UPLOAD_RELEASE_TOKEN} \
+  release ${REPO_NAME} edit ${PRERELEASE_NAME} --target-commitish ${sha} --name "${release_name}"
+

tox.ini

@@ -10,3 +10,4 @@ deps=
 commands=
     flake8
     py.test
+    python setup.py sdist bdist_wheel