New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DOC: document the release process #835

Merged
merged 2 commits into from Nov 12, 2015

Conversation

Projects
None yet
2 participants
@llllllllll
Member

llllllllll commented Nov 11, 2015

Typo hunting begins now!

page. We will have been maintaining a whatsnew file while working on the release
with the new version. First, find that file in:
``docs/source/whatsnew/<version>.txt``. It will be the highest version number.
Edit the release date field to be todays date in the format:

This comment has been minimized.

@richafrank

richafrank Nov 11, 2015

Member

"today's"

We use `versioneer <https://github.com/warner/python-versioneer>`__ to
manage the ``__version__`` and ``setup.py`` version. This means that we pull
this information from our version control's tags to ensure that they stay in
sync and to have very fine grain version strings for development installs.

This comment has been minimized.

@richafrank

richafrank Nov 11, 2015

Member

Is it "fine grain" or "fine grained"?


.. note::

It is very important to both ``cd`` into a clean directory and make a clean

This comment has been minimized.

@richafrank

If the package version has been taken: locally update your setup.py to
override the version with a new number. Do not use the next version, just
append a ``.<nano>`` section to the current version. PyPI prevents the same

This comment has been minimized.

@richafrank

richafrank Nov 11, 2015

Member

Would it be easier to delete that version from the test server?

This comment has been minimized.

@llllllllll

llllllllll Nov 11, 2015

Member

You can still never use it again, even if it has been deleted

This comment has been minimized.

@richafrank

richafrank Nov 11, 2015

Member

Oh wow, ok.

.. code-block:: bash
$ python setup.py sdist upload
$ python -c 'import zipline;print(zipline.__version__)'

This comment has been minimized.

@richafrank

richafrank Nov 11, 2015

Member

Should these two be run in different virtualenvs?

This comment has been minimized.

@llllllllll

llllllllll Nov 11, 2015

Member

yeah, I will split these commands

Just like the ``sdist``, we need to ``cd`` into a clean directory and use a
clean virtualenv. Then, test that the wheel was built successfully with:

This comment has been minimized.

@richafrank

richafrank Nov 11, 2015

Member

Should we mention something about building for each version of python?

This comment has been minimized.

@llllllllll

@llllllllll llllllllll force-pushed the release-docs branch 2 times, most recently from e56bc07 to b37b7cd Nov 12, 2015

@llllllllll llllllllll merged commit b37b7cd into master Nov 12, 2015

0 of 2 checks passed

Scrutinizer Scheduled/Installing
Details
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details

@llllllllll llllllllll deleted the release-docs branch Nov 12, 2015

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment