Clean up pytest and add mypy handling (#300)

* clean up pytest and add mypy handling

* add py.typed file

* fix up workflows

* cleanup

* cleanup

* cleanup

* fix docs links and win run

* another windows fix

* invert order

* clean up event loop handling

Author: blink1073

.github/workflows/draft-changelog.yml

@@ -7,14 +7,18 @@ on:
         required: true
       branch:
         description: "The branch to target (defaults to default branch)"
+        required: false
       version_spec:
         description: "New Version Spec"
         default: "next"
+        required: false
       since:
-        description: Use PRs with activity since this date or git reference
+        description: "Use PRs with activity since this date or git reference"
+        required: false
       since_last_stable:
-        description: Use PRs with activity since the last stable git tag
+        description: "Use PRs with activity since the last stable git tag"
         type: boolean
+        required: false
 jobs:
   draft_changelog:
     runs-on: ubuntu-latest

.github/workflows/draft-release.yml

@@ -7,18 +7,24 @@ on:
         required: true
       branch:
         description: "The branch to target (defaults to default branch)"
+        required: false
       version_spec:
         description: "New Version Spec"
         default: "next"
+        required: false
       post_version_spec:
         description: "Post Version Specifier"
+        required: false
       since:
-        description: Use PRs with activity since this date or git reference
+        description: "Use PRs with activity since this date or git reference"
+        required: false
       since_last_stable:
-        description: Use PRs with activity since the last stable git tag
+        description: "Use PRs with activity since the last stable git tag"
+        required: false
         type: boolean
       steps_to_skip:
-        description: Comma separated list of steps to skip
+        description: "Comma separated list of steps to skip"
+        required: false
 jobs:
   draft_release:
     runs-on: ubuntu-latest

.github/workflows/full-release.yml

@@ -7,18 +7,24 @@ on:
         required: true
       branch:
         description: "The branch to target (defaults to default branch)"
+        required: false
       version_spec:
         description: "New Version Spec"
+        required: false
         default: "next"
       post_version_spec:
         description: "Post Version Specifier"
+        required: false
       since:
-        description: Use PRs with activity since this date or git reference
+        description: "Use PRs with activity since this date or git reference"
+        required: false
       since_last_stable:
-        description: Use PRs with activity since the last stable git tag
+        description: "Use PRs with activity since the last stable git tag"
+        required: false
         type: boolean
       steps_to_skip:
-        description: Comma separated list of steps to skip
+        description: "Comma separated list of steps to skip"
+        required: false
 
 jobs:
   full_release:

.github/workflows/generate-changelog.yml

@@ -3,17 +3,21 @@ on:
   workflow_dispatch:
     inputs:
       target:
-        description: Target Owner/Repo
+        description: "Target Owner/Repo"
         required: true
       branch:
-        description: The branch or reference name to filter pull requests by
+        description: "The branch or reference name to filter pull requests by"
+        required: false
       convert_to_rst:
-        description: Whether to convert to RST
+        description: "Whether to convert to RST"
+        required: false
         type: boolean
       since:
-        description: Use PRs with activity since this date or git reference
+        description: "Use PRs with activity since this date or git reference"
+        required: false
       until:
-        description: Use PRs with activity until this date or git reference
+        description: "Use PRs with activity until this date or git reference"
+        required: false
 jobs:
   generate_changelog:
     runs-on: ubuntu-latest

.github/workflows/publish-release.yml

@@ -6,7 +6,8 @@ on:
         description: "The URL of the draft GitHub release"
         required: true
       steps_to_skip:
-        description: comma-separated list of steps to skip
+        description: "comma-separated list of steps to skip"
+        required: false
 jobs:
   publish_release:
     runs-on: ubuntu-latest

.github/workflows/test.yml

@@ -58,12 +58,12 @@ jobs:
           pip install -e .[test] codecov
 
       - name: Run the tests with coverage on Ubuntu
-        if: ${{ matrix.os == 'ubuntu' }}
+        if: ${{ matrix.os == 'ubuntu-latest' }}
         run: |
           python -m pytest -vv --cov jupyter_releaser --cov-branch --cov-report term-missing:skip-covered
 
       - name: Run the tests on Windows and macOS
-        if: ${{ matrix.os != 'ubuntu' }}
+        if: ${{ matrix.os != 'ubuntu-latest' }}
         run: |
           python -m pytest -vv -s
 

.pre-commit-config.yaml

@@ -50,3 +50,22 @@ repos:
             "flake8-implicit-str-concat==0.2.0",
           ]
         stages: [manual]
+
+  - repo: https://github.com/pre-commit/mirrors-mypy
+    rev: v0.942
+    hooks:
+      - id: mypy
+        args: ["--config-file", "pyproject.toml"]
+        additional_dependencies:
+          [pytest, click, importlib_resources, types-requests]
+        stages: [manual]
+
+  - repo: https://github.com/sirosen/check-jsonschema
+    rev: 0.14.2
+    hooks:
+      - id: check-jsonschema
+        name: "Check GitHub Workflows"
+        files: ^\.github/workflows/
+        types: [yaml]
+        args: ["--schemafile", "https://json.schemastore.org/github-workflow"]
+        stages: [manual]

MANIFEST.in

@@ -4,3 +4,4 @@ prune media
 prune docs
 exclude readthedocs.yml
 include jupyter_releaser/schema.json
+include jupyter_releaser/py.typed

docs/source/conf.py

@@ -48,7 +48,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This pattern also affects html_static_path and html_extra_path.
-exclude_patterns = []
+# exclude_patterns = []
 
 
 # -- Options for HTML output -------------------------------------------------

jupyter_releaser/actions/draft_changelog.py

@@ -16,8 +16,8 @@
     if not os.environ.get("RH_SINCE"):
         curr_dir = os.getcwd()
         os.chdir(CHECKOUT_NAME)
-        since_last_stable = os.environ.get("RH_SINCE_LAST_STABLE")
-        since_last_stable = since_last_stable == "true"
+        since_last_stable_env = os.environ.get("RH_SINCE_LAST_STABLE")
+        since_last_stable = since_last_stable_env == "true"
         since = get_latest_tag(os.environ.get("RH_BRANCH"), since_last_stable)
         if since:
             log(f"Capturing {since} in RH_SINCE variable")