Skip to content

Commit

Permalink
docs(release): add conda forge release notes
Browse files Browse the repository at this point in the history
  • Loading branch information
TheKevJames committed Aug 27, 2017
1 parent 348cb19 commit 476c007
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions docs/release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,24 +5,31 @@ This project is released on PyPI as `coveralls`_.

To cut a new release, ensure the latest master passes all tests. Then, create a release commit:

1. Update the :code:`CHANGELOG.md` with the new version (:code:`clog -C CHANGELOG.md -F --setversion x.y.z`).
2. Bump the version number in :code:`version.py`.
3. Tag that commit with the version number (:code:`git tag x.y.z`).
1. Update the ``CHANGELOG.md`` with the new version (``clog -C CHANGELOG.md -F --setversion x.y.z``).
2. Bump the version number in ``version.py``.
3. Tag that commit with the version number (``git tag x.y.z``).
4. Push the new tag to GitHub.
5. Create a new `GitHub release`_.

Make sure to push the release commit to GitHub.

To create a new PyPI release, do the following:

1. Build the sources (:code:`python setup.py sdist bdist_wheel`).
2. Register & upload the sources. (:code:`twine upload dist/*`).
1. Build the sources (``python setup.py sdist bdist_wheel``).
2. Register & upload the sources. (``twine upload dist/*``).

NOTE: in the future, we may want to expand this to include other sources, such as eggs for various Python versions. Since we already test with :code:`tox`, this could be as simple as::

.tox/py34/bin/python setup.py bdist_egg
.tox/py35/bin/python setup.py bdist_egg
# etc

To create a new Conda Forge release, do the following:

1. Fork `coveralls-feedstock`_.
2. Update ``recipe/meta.yaml`` with the new version number.
3. Create a PR. A conda-forge maintainer will get to it eventually.

.. _coveralls: https://pypi.org/project/coveralls/
.. _coveralls-feedstock: https://github.com/conda-forge/coveralls-feedstock
.. _GitHub release: https://github.com/coveralls-clients/coveralls-python/releases/new

0 comments on commit 476c007

Please sign in to comment.