Skip to content

Commit

Permalink
docs: Update README, CHANGES and make_a_release
Browse files Browse the repository at this point in the history
[ci skip]
  • Loading branch information
jcfr committed Jul 9, 2018
1 parent 0db8631 commit a7053b6
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 11 deletions.
17 changes: 17 additions & 0 deletions CHANGES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,23 @@ Release Notes
This is the list of changes to scikit-build between each release. For full
details, see the commit logs at http://github.com/scikit-build/scikit-build

Next Release
============

Documentation
-------------

* README: Update overall download count.

Scikit-build 0.7.1
==================

Documentation
-------------

* Fix description and classifier list in setup.py.
* Fix link in README.

Scikit-build 0.7.0
==================

Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Latest Release
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| Versions | Downloads |
+=============================================================================+===============================================================================+
| .. image:: https://img.shields.io/pypi/v/scikit-build.svg?maxAge=2592000 | .. image:: https://img.shields.io/badge/downloads-15k%20total-green.svg |
| .. image:: https://img.shields.io/pypi/v/scikit-build.svg?maxAge=2592000 | .. image:: https://img.shields.io/badge/downloads-44k%20total-green.svg |
| :target: https://pypi.python.org/pypi/scikit-build | :target: https://pypi.python.org/pypi/scikit-build |
+-----------------------------------------------------------------------------+-------------------------------------------------------------------------------+
| .. image:: https://anaconda.org/conda-forge/scikit-build/badges/version.svg | .. image:: https://anaconda.org/conda-forge/scikit-build/badges/downloads.svg |
Expand Down
22 changes: 12 additions & 10 deletions docs/make_a_release.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,9 @@ A core developer should use the following steps to create a release `X.Y.Z` of

0. Configure `~/.pypirc` as described `here <https://packaging.python.org/distributing/#uploading-your-project-to-pypi>`_.

1. Make sure that all CI tests are passing.
1. Make sure that all CI tests are passing: `AppVeyor <https://ci.appveyor.com/project/scikit-build/scikit-build>`_,
`CircleCI <https://circleci.com/gh/scikit-build/scikit-build>`_
and `TravisCi <https://travis-ci.org/scikit-build/scikit-build>`_.

2. Update version numbers and download count:

Expand All @@ -22,36 +24,36 @@ A core developer should use the following steps to create a release `X.Y.Z` of

3. Commit the changes using title ``scikit-build X.Y.Z``.

3. Create the source tarball and binary wheels::
4. Create the source tarball and binary wheels::

git checkout master
git fetch upstream
git reset --hard upstream/master
rm -rf dist/
python setup.py sdist bdist_wheel

4. Upload the packages to the testing PyPI instance::
5. Upload the packages to the testing PyPI instance::

twine upload --sign -r pypitest dist/*

5. Check the `PyPI testing package page <https://testpypi.python.org/pypi/scikit-build/>`_.
6. Check the `PyPI testing package page <https://testpypi.python.org/pypi/scikit-build/>`_.

6. Tag the release. Requires a GPG key with signatures. For version *X.Y.Z*::
7. Tag the release. Requires a GPG key with signatures. For version *X.Y.Z*::

git tag -s -m "scikit-build X.Y.Z" X.Y.Z upstream/master

7. Upload the packages to the PyPI instance::
8. Upload the packages to the PyPI instance::

twine upload --sign dist/*

8. Check the `PyPI package page <https://pypi.python.org/pypi/scikit-build/>`_.
9. Check the `PyPI package page <https://pypi.python.org/pypi/scikit-build/>`_.

9. Make sure the package can be installed::
10. Make sure the package can be installed::

mkvirtualenv skbuild-pip-install
pip install scikit-build
rmvirtualenv skbuild-pip-install

10. Add a ``Next Release`` section back in `CHANGES.rst` and merge the result.
11. Add a ``Next Release`` section back in `CHANGES.rst` and merge the result.

11. Push local changes
12. Push local changes

0 comments on commit a7053b6

Please sign in to comment.