Clarify release procedure
@@ -23,7 +23,7 @@ of manual steps:
1. Add any new contributors to `AUTHORS.rst`.
-2. Change the version number in `lightkurve/version.py`. Lightkurve follows a `semantic versioning scheme <https://semver.org>`_.
+2. Remove the suffix `.dev` from the version number in `lightkurve/version.py`. Note that Lightkurve follows a `semantic versioning scheme <https://semver.org>`_.
3. Verify that all unit tests pass:
@@ -31,26 +31,25 @@ of manual steps:
$ pytest --remote-data
-4. Make a new release branch in GitHub using the `Draft a new release button` at https://github.com/KeplerGO/lightkurve/releases.
-
-5. Create and upload the new package to PyPI:
-
-.. code-block:: bash
-
- $ python setup.py release
-
-6. Update the online docs:
+4. Verify that the docs and all tutorial notebooks can be compiled without failure, and upload them to the webserver:
.. code-block:: bash
$ cd docs
$ make clean
+ $ make notebooks
$ make html
$ make upload
-7. Edit `lightkurve/version.py` to contain the next version number with suffix `.dev`.
+5. Make a new release branch in GitHub using the `Draft a new release button` at https://github.com/KeplerGO/lightkurve/releases.
-8. Increment the version number on the `lightkurve conda feedstock <https://github.com/conda-forge/lightkurve-feedstock>`_. Specifically you will need to navigate to the :code:`meta.yaml` file in the :code:`recipe` directory:
+6. Create and upload the new package to PyPI:
+
+.. code-block:: bash
+
+ $ python setup.py release
+
+7. Increment the version number on the `lightkurve conda feedstock <https://github.com/conda-forge/lightkurve-feedstock>`_. Specifically you will need to navigate to the :code:`meta.yaml` file in the :code:`recipe` directory:
.. code-block:: yaml
@@ -58,3 +57,5 @@ of manual steps:
{% set sha256 = "b65f556362b64d9fcc8aa4b0e89991c2b8f7fc059dfa22269b0877a8b758b255" %}
You need to replace the version and sha256 values. You can retrieve the sha256 value from the "Download files" section of `the lightkurve PyPI <https://pypi.org/project/lightkurve/>`_. Submit your update as a Pull Request, which offers a checklist to guide programmatic spot-checking of your code.
+
+8. Edit `lightkurve/version.py` to contain the next version number with suffix `.dev`.
