docs: Add developer release checklist Issue template (#1493)

* Add a developer release checklist GitHub Issue template
   - Restrict the Issue template to be usable by project maintainers only
* Add a section to the development docs mentioning the Issue template

.github/ISSUE_TEMPLATE/~release-checklist.md

@@ -0,0 +1,38 @@
+---
+name: (Maintainers Only) Release Checklist
+about: Checklist for core developers to complete as part of making a release
+
+---
+# Release Checklist
+
+## Before Release
+
+* [ ] Migrate any unresolved Issues or PRs from the [release GitHub project board](https://github.com/scikit-hep/pyhf/projects/) to a new project board.
+* [ ] Verify that there is a release notes file for the release under [``docs/release-notes``](https://github.com/scikit-hep/pyhf/tree/master/docs/release-notes).
+* [ ] Verify that the release notes files correctly summarize all development changes since the last release.
+* [ ] Draft email to [``pyhf-announcements`` mailing list](https://groups.google.com/group/pyhf-announcements/subscribe) that summarizes the main points of the release notes and circulate it for development team approval.
+* [ ] Update the checklist Issue template in the [``.github/ISSUE_TEMPLATE``](https://github.com/scikit-hep/pyhf/tree/master/.github/ISSUE_TEMPLATE) directory if there are revisions.
+* [ ] Verify that the project README is displaying correctly on [TestPyPI](https://test.pypi.org/project/pyhf/).
+* [ ] Add any new use citations or published statistical models to the [Use and Citations page](https://scikit-hep.org/pyhf/citations.html).
+* [ ] Update the [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish) GitHub Action used for deployment to TestPyPI and PyPI to the latest stable release.
+* [ ] Update the ``codemeta.json`` file in the release PR if its requirements have updated.
+
+## Once Release PR is Merged
+
+* [ ] Watch the CI to ensure that the deployment to [PyPI](https://pypi.org/project/pyhf/) is successful.
+* [ ] Create a [GitHub release](https://github.com/scikit-hep/pyhf/releases) from the generated PR tag and copy the release notes published to the GitHub release page. The creation of the GitHub release triggers all other release related activities.
+* [ ] Verify there is a new [Zenodo DOI](https://doi.org/10.5281/zenodo.1169739) minted for the release.
+* [ ] Verify that a Binder has properly built for the new release.
+* [ ] Watch for a GitHub notification that there is an automatic PR to the
+  [Conda-forge feedstock](https://github.com/conda-forge/pyhf-feedstock). This may take multiple hours to happen. If there are any changes needed to the Conda-forge release make them **from a personal account** and not from an organization account to have workflows properly trigger.
+
+## After Release
+
+* [ ] Verify that the release is installable from both [PyPI](https://pypi.org/project/pyhf/) and [Conda-forge](https://github.com/conda-forge/pyhf-feedstock).
+* [ ] Send the drafted ``pyhf-announcements`` email out from the ``pyhf-announcements`` account email.
+* [ ] Tweet the release out on both personal and team Twitter accounts.
+* [ ] Announce the release on the [Scikit-HEP community Gitter](https://gitter.im/Scikit-HEP/community).
+* [ ] Make a release for the [`pyhf` tutorial](https://github.com/pyhf/pyhf-tutorial/releases) corresponding to the **previous release** number. This release represents the last version of the tutorial that is guaranteed to work with previous release API.
+* [ ] Update the [tutorial](https://github.com/pyhf/pyhf-tutorial) to use the new release number and API.
+* [ ] Make a PR to use the new release in the [CUDA enabled Docker images](https://github.com/pyhf/cuda-images).
+* [ ] Close the [release GitHub Project board](https://github.com/scikit-hep/pyhf/projects/).

docs/development.rst

@@ -1,6 +1,10 @@
+==========
 Developing
 ==========
 
+Developer Environment
+---------------------
+
 To develop, we suggest using `virtual environments <https://packaging.python.org/tutorials/installing-packages/#creating-virtual-environments>`__ together with ``pip`` or using `pipenv <https://pipenv.readthedocs.io/en/latest/>`__. Once the environment is activated, clone the repo from GitHub
 
 .. code-block:: console
@@ -107,3 +111,11 @@ of ``pyhf`` using ``codemetapy``
 though the ``author`` metadata will still need to be checked and revised by hand.
 The ``.zenodo.json`` is currently generated by hand, so it is worth using
 ``codemeta.json`` as a guide to edit it.
+
+Release Checklist
+-----------------
+
+As part of the release process a checklist is required to be completed to make
+sure steps aren't missed.
+There is a GitHub Issue template for this that the developer in charge of the
+release should step through and update if needed.