Updating release notes (#56)

* updating release notes

* using github version of towncrier

* updating docs for release building

* moving news ci to it's own workflow

* naming

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

.github/workflows/news.yml

@@ -0,0 +1,25 @@
+name: News
+
+on:
+  pull_request:
+    paths-ignore:
+      - ".pre-commit-config.yaml"
+
+jobs:
+  news:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.9"
+      - name: Install dependencies
+        run: |
+          python -m pip install -U pip
+          # FIXME: using github towncrier until next release
+          python -m pip install https://github.com/twisted/towncrier/archive/6b1527b6bf2cbb293ef411ac4f300bd50a5c98ae.zip
+      - name: Check for news
+        run: python -m towncrier check --compare-with origin/main

.github/workflows/tests.yml

@@ -6,30 +6,9 @@ on:
       - main
     tags:
       - "*"
-    paths-ignore:
-      - "joss/**"
-      - "docs/**"
   pull_request:
 
 jobs:
-  news:
-    if: github.event_name == 'pull_request'
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
-      - name: Setup Python
-        uses: actions/setup-python@v2
-        with:
-          python-version: "3.9"
-      - name: Install dependencies
-        run: |
-          python -m pip install -U pip
-          python -m pip install towncrier
-      - name: Check for news
-        run: python -m towncrier check --compare-with origin/main
-
   tests:
     runs-on: ubuntu-latest
     strategy:

CONTRIBUTING.md

@@ -31,10 +31,6 @@ Example](https://stackoverflow.com/help/minimal-reproducible-example).
 Feel free to request features on the [Issue
 Tracker](https://github.com/dfm/tinygp/issues).
 
-## How to set up your development environment
-
-TODO
-
 ## How to test the project
 
 ```bash
@@ -45,3 +41,35 @@ python -m tox
 ## How to submit changes
 
 Open a [Pull Request](https://github.com/dfm/tinygp/pulls).
+
+We use the [towncrier](https://github.com/twisted/towncrier) package to manage
+release notes, so you should include a "news fragment" in the `/news` directory
+describing your changes. We'll be happy to help on the pull request thread to
+format that appropriately.
+
+## Making a new release
+
+These are the steps that need to be run when minting a new release:
+
+1. Make sure that your local copy of main is up-to-date:
+
+   ```bash
+   git pull origin main
+   ```
+
+2. Check out a new branch:
+
+   ```bash
+   git checkout -b release
+   ```
+
+3. Update the release notes, using the version number that you're going to bump
+   to (try running with `--draft` first):
+
+   ```bash
+   python -m towncrier build --version THE_NEXT_VERSION
+   ```
+
+4. Open a PR with the new release notes and make sure that all the tests pass.
+5. Make a release on GitHub (it's good practice to make a release candidate
+   first, just to be safe) with the appropriate version number.

docs/guide.md

@@ -14,4 +14,5 @@ motivation
 install
 troubleshooting
 benchmarks
+news
 ```

docs/news.rst

@@ -0,0 +1,40 @@
+.. _release:
+
+Release Notes
+=============
+
+.. towncrier release notes start
+
+tinygp 0.2.0 (2022-03-03)
+-------------------------
+
+Features
+~~~~~~~~
+
+- Added new interface for conditioning GP models. ``condition`` method now returns
+  a :class:`tinygp.GaussianProcess` object describing the conditional
+  distribution. (`#32 <https://github.com/dfm/tinygp/issues/32>`_)
+- Added new experimental scalable solver using quasiseparable matrices. See
+  :ref:`api-kernels-quasisep`, :ref:`api-solvers-quasisep`, and
+  :class:`tinygp.solvers.quasisep.solver.QuasisepSolver` for more information. (`#47 <https://github.com/dfm/tinygp/issues/47>`_)
+
+
+Improved Documentation
+~~~~~~~~~~~~~~~~~~~~~~
+
+- Updated benchmarks to include quasiseparable solver. (`#49 <https://github.com/dfm/tinygp/issues/49>`_)
+- Major overhaul of API documentation. Added many docstrings and expanded text
+  thoughout the API docs pages. (`#52 <https://github.com/dfm/tinygp/issues/52>`_)
+- Added 3 new tutorials: (1) :ref:`intro`, giving a general introduction to
+  ``tinygp``, (2) :ref:`means`, showing how ``tinygp`` can be used with a
+  non-trivial mean function, and (3) :ref:`quasisep`, introducing the scalable
+  solver for quasiseparable kernels. (`#54 <https://github.com/dfm/tinygp/issues/54>`_)
+- Added support for `towncrier <https://github.com/twisted/towncrier>`_ generated
+  release notes. (`#55 <https://github.com/dfm/tinygp/issues/55>`_)
+
+
+Deprecations and Removals
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+- Breaking change: Removed existing ``condition`` method and deprected ``predict``
+  method. (`#32 <https://github.com/dfm/tinygp/issues/32>`_)

pyproject.toml

@@ -32,8 +32,10 @@ show_missing = true
 all = true
 
 [tool.towncrier]
+name = "tinygp"
 package = "tinygp"
 package_dir = "src"
-filename = "NEWS.rst"
+filename = "docs/news.rst"
 directory = "news/"
 issue_format = "`#{issue} <https://github.com/dfm/tinygp/issues/{issue}>`_"
+underlines = "-~~"