From 85be53cfc0f76b3b645e508dc5354a12fee8b903 Mon Sep 17 00:00:00 2001 From: Cameron Yick Date: Sat, 7 Jul 2018 13:26:02 -0400 Subject: [PATCH] Add New Release notes --- CONTRIBUTING.rst | 7 ++++++- RELEASE.rst | 13 +++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) create mode 100644 RELEASE.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index bff2266..3bfc3e8 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -105,6 +105,12 @@ Before you submit a pull request, check that it meets these guidelines: https://travis-ci.org/hydrosquall/tiingo-python/pull_requests and make sure that the tests pass for all supported Python versions. + +Release Procedure +----------------------- + +See RELEASE.rst . + Tips ---- @@ -125,4 +131,3 @@ In order for py.test to run, you will have had to create an environment variable However, now this api key will become embedded in the test fixture file that is created per the prior procedure. In order to remove this api key from the new test fixtures, run the following from the top level directory:: $ ./tools/api_key_tool.py - diff --git a/RELEASE.rst b/RELEASE.rst new file mode 100644 index 0000000..5ddbcbe --- /dev/null +++ b/RELEASE.rst @@ -0,0 +1,13 @@ +============ +Issuing New Releases +============ + +Tiingo follows semantic versioning (semver.org) practices. + +The following shows how to make a release for version 0.8.0 + +1. Make a branch called release/0.8.0 +2. Ensure HISTORY.rst (the Changelog) is up to date +3. Update __version__.py to 0.8.0 +4. Open a merge request to master +5. After the merge request is approved and merged, tag and push the merged commit with 0.8.0. Travis CI will be responsible for releasing the new code to PyPI.