From 8854bab793de8c7eddecaf0497219b4537d58cd8 Mon Sep 17 00:00:00 2001
From: Nicholas Bollweg <nick.bollweg@gmail.com>
Date: Mon, 7 Nov 2022 08:51:56 -0600
Subject: [PATCH] add issue templates

---
 .github/ISSUE_TEMPLATE/bug_report.md | 10 ++++-----
 .github/ISSUE_TEMPLATE/release.md    | 32 ++++++++++++++++++++++++++++
 scripts/project.py                   |  2 +-
 3 files changed, 38 insertions(+), 6 deletions(-)
 create mode 100644 .github/ISSUE_TEMPLATE/release.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index e0a3bac..53c38dd 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -38,7 +38,7 @@ https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html
 - Operating System and version:
 - Browser and version:
 - JupyterLab version:
-- ipydrawio version(s): 
+- `ipydrawio-*` version(s):
 
 <details><summary>Required: installed server extensions</summary>
 <pre>
@@ -74,10 +74,10 @@ https://jupyterlab.readthedocs.io/en/latest/getting_started/issue.html
 <pre>
   Paste the output from your browser JavaScript console replacing the text in here.
 
-  To learn how to open the developer tools in your browser:
-  https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_are_browser_developer_tools#How_to_open_the_devtools_in_your_browser
-  If too many messages accumulated after many hours of working in JupyterLab,
-  consider refreshing the window and then reproducing the bug to reduce the noise in the logs.
+To learn how to open the developer tools in your browser:
+https://developer.mozilla.org/en-US/docs/Learn/Common_questions/What_are_browser_developer_tools#How_to_open_the_devtools_in_your_browser
+If too many messages accumulated after many hours of working in JupyterLab, consider
+refreshing the window and then reproducing the bug to reduce the noise in the logs.
 
 </pre>
 </details>
diff --git a/.github/ISSUE_TEMPLATE/release.md b/.github/ISSUE_TEMPLATE/release.md
new file mode 100644
index 0000000..debd704
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/release.md
@@ -0,0 +1,32 @@
+---
+name: Release
+about: Prepare for a release
+labels: maintenance
+---
+
+- [ ] merge all outstanding PRs
+- [ ] ensure the versions have been bumped (check with `doit test:integrity`)
+- [ ] ensure the CHANGELOG is up-to-date
+  - [ ] move the new release to the top of the stack
+- [ ] validate on binder
+- [ ] validate on ReadTheDocs
+- [ ] wait for a successful build of `master`
+- [ ] download the `dist` archive and unpack somewhere (maybe a fresh `dist`)
+- [ ] create a new release through the GitHub UI
+  - [ ] paste in the relevant CHANGELOG entries
+  - [ ] upload the artifacts
+- [ ] actually upload to npm.com, pypi.org
+  ```bash
+  cd dist
+  twine upload *.tar.gz *.whl
+  npm login
+  npm publish deathbeds-*-$VERSION.tgz
+  npm logout
+  ```
+- [ ] postmortem
+  - [ ] handle `conda-forge` feedstock tasks
+  - [ ] validate on binder via simplest-possible gists
+  - [ ] bump to next development version
+  - [ ] bump the `CACHE_EPOCH`
+  - [ ] rebuild `yarn.lock`
+  - [ ] update release procedures with lessons learned
diff --git a/scripts/project.py b/scripts/project.py
index 9bbedd9..22dc60f 100644
--- a/scripts/project.py
+++ b/scripts/project.py
@@ -512,7 +512,7 @@ ALL_JSON = [
     ],
 ]
 ALL_DIO = [*DOCS_DIO, *IPJT_TMPL_DIO, *ATEST_DIO]
-ALL_MD = [*ROOT.glob("*.md"), *PACKAGES.glob("*/*.md"), *DOCS_MD]
+ALL_MD = [*ROOT.glob("*.md"), *PACKAGES.glob("*/*.md"), *DOCS_MD, *GH.rglob("*.md")]
 ALL_SETUP_CFG = [SETUP_CFG, *PY_SETUP_CFG.values()]
 ALL_JS = [PACKAGES / ".eslintrc.js"]
 ALL_TS = sum(JS_TSSRC.values(), [])