Updated files with 'repo_helper'. (#5)

Co-authored-by: repo-helper[bot] <74742576+repo-helper[bot]@users.noreply.github.com>
domdfcoding · Dec 18, 2020 · 68a343f · 68a343f
1 parent c982ce3
commit 68a343f
Show file tree

Hide file tree

Showing 15 changed files with 190 additions and 66 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -0,0 +1,10 @@
+# This file is managed by 'repo_helper'. Don't edit it directly.
+---
+version: 2
+updates:
+- package-ecosystem: pip
+  directory: /
+  schedule:
+    interval: weekly
+  reviewers:
+  - domdfcoding
diff --git a/.github/workflows/flake8.yml b/.github/workflows/flake8.yml
@@ -0,0 +1,32 @@
+# This file is managed by 'repo_helper'. Don't edit it directly.
+---
+name: Flake8
+
+on:
+  push:
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  Run:
+    name: "Flake8"
+    runs-on: "ubuntu-18.04"
+
+    steps:
+      - name: Checkout 🛎️
+        uses: "actions/checkout@v2"
+
+      - name: Setup Python 🐍
+        uses: "actions/setup-python@v2"
+        with:
+          python-version: "3.8"
+
+      - name: Install dependencies 🔧
+        run: |
+          python -VV
+          python -m site
+          python -m pip install --upgrade pip setuptools wheel
+          python -m pip install tox
+
+      - name: "Run Flake8"
+        run: "python -m tox -e lint -- --format github"
diff --git a/.github/workflows/mypy.yml b/.github/workflows/mypy.yml
@@ -0,0 +1,37 @@
+# This file is managed by 'repo_helper'. Don't edit it directly.
+---
+name: mypy
+
+on:
+  push:
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  Run:
+    name: "mypy"
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest, macos-latest]
+      fail-fast: false
+
+    steps:
+      - name: Checkout 🛎️
+        uses: "actions/checkout@v2"
+
+      - name: Setup Python 🐍
+        uses: "actions/setup-python@v2"
+        with:
+          python-version: "3.6"
+
+      - name: Install dependencies 🔧
+        run: |
+          python -VV
+          python -m site
+          python -m pip install --upgrade pip setuptools wheel
+          python -m pip install tox
+
+      - name: "Run mypy"
+        run: "python -m tox -e mypy"
diff --git a/.github/workflows/octocheese.yml b/.github/workflows/octocheese.yml
@@ -4,6 +4,7 @@
 name: "GitHub Releases"
 on:
   push:
+    branches: ["master"]
   schedule:
     - cron: 0 12 * * 2,4,6
 
@@ -16,3 +17,4 @@ jobs:
           pypi_name: "octo-api"
         env:
           GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+        if: startsWith(github.ref, 'refs/tags/') != true
diff --git a/.github/workflows/python_ci.yml b/.github/workflows/python_ci.yml
@@ -1,6 +1,6 @@
 # This file is managed by 'repo_helper'. Don't edit it directly.
 ---
-name: Windows Tests
+name: Windows
 
 on:
   push:
@@ -9,30 +9,36 @@ on:
 
 jobs:
   tests:
-    name: "Python ${{ matrix.python-version }}"
+    name: "Python ${{ matrix.config.python-version }}"
     runs-on: "windows-2019"
+    continue-on-error: ${{ matrix.config.experimental }}
     env:
       USING_COVERAGE: '3.6,3.7,3.8,3.9'
 
     strategy:
       fail-fast: False
       matrix:
-        python-version: ["3.6","3.7","3.8","3.9"]
+        config:
+          - {python-version: "3.6", testenvs: "py36,build", experimental: False}
+          - {python-version: "3.7", testenvs: "py37,build", experimental: False}
+          - {python-version: "3.8", testenvs: "py38,build", experimental: False}
+          - {python-version: "3.9", testenvs: "py39,build", experimental: False}
 
     steps:
       - name: Checkout 🛎️
         uses: "actions/checkout@v2"
+
       - name: Setup Python 🐍
         uses: "actions/setup-python@v2"
         with:
-          python-version: "${{ matrix.python-version }}"
+          python-version: "${{ matrix.config.python-version }}"
+
       - name: Install dependencies 🔧
         run: |
           python -VV
           python -m site
           python -m pip install --upgrade pip setuptools wheel
-          python -m pip install --upgrade tox tox-gh-actions virtualenv
-
+          python -m pip install --upgrade tox virtualenv
 
-      - name: "Run Tests for Python ${{ matrix.python-version }}"
-        run: "python -m tox"
+      - name: "Run Tests for Python ${{ matrix.config.python-version }}"
+        run: "python -m tox -e ${{ matrix.config.testenvs }}"
diff --git a/.github/workflows/python_ci_linux.yml b/.github/workflows/python_ci_linux.yml
@@ -1,6 +1,6 @@
 # This file is managed by 'repo_helper'. Don't edit it directly.
 ---
-name: Linux Tests
+name: Linux
 
 on:
   push:
@@ -9,45 +9,52 @@ on:
 
 jobs:
   tests:
-    name: "Python ${{ matrix.python-version }}"
-    runs-on: "ubuntu-18.04"
+    name: "Python ${{ matrix.config.python-version }}"
+    runs-on: "ubuntu-20.04"
+    continue-on-error: ${{ matrix.config.experimental }}
     env:
       USING_COVERAGE: '3.6,3.7,3.8,3.9'
 
     strategy:
       fail-fast: False
       matrix:
-        python-version: ["3.6","3.7","3.8","3.9"]
+        config:
+          - {python-version: "3.6", testenvs: "py36,build", experimental: False}
+          - {python-version: "3.7", testenvs: "py37,build", experimental: False}
+          - {python-version: "3.8", testenvs: "py38,build", experimental: False}
+          - {python-version: "3.9", testenvs: "py39,build", experimental: False}
 
     steps:
       - name: Checkout 🛎️
         uses: "actions/checkout@v2"
+
       - name: Setup Python 🐍
         uses: "actions/setup-python@v2"
         with:
-          python-version: "${{ matrix.python-version }}"
+          python-version: "${{ matrix.config.python-version }}"
+
       - name: Install dependencies 🔧
         run: |
           python -VV
           python -m site
           python -m pip install --upgrade pip setuptools wheel
-          python -m pip install --upgrade tox tox-gh-actions virtualenv
+          python -m pip install --upgrade tox virtualenv
           python -m pip install --upgrade coverage_pyver_pragma
 
-      - name: "Run Tests for Python ${{ matrix.python-version }}"
-        run: "python -m tox"
+      - name: "Run Tests for Python ${{ matrix.config.python-version }}"
+        run: "python -m tox -e ${{ matrix.config.testenvs }}"
 
 
       - name: "Upload Coverage"
         uses: actions/upload-artifact@v2
         with:
-          name: "coverage-${{ matrix.python-version }}"
+          name: "coverage-${{ matrix.config.python-version }}"
           path: .coverage
 
 
   Coverage:
     needs: tests
-    runs-on: "ubuntu-18.04"
+    runs-on: "ubuntu-20.04"
     steps:
       - name: Checkout 🛎️
         uses: "actions/checkout@v2"
@@ -91,7 +98,7 @@ jobs:
   Deploy:
     needs: tests
 
-    runs-on: "ubuntu-18.04"
+    runs-on: "ubuntu-20.04"
     steps:
       - name: Checkout 🛎️
         uses: "actions/checkout@v2"

diff --git a/.github/workflows/python_ci_macos.yml b/.github/workflows/python_ci_macos.yml
@@ -1,6 +1,6 @@
 # This file is managed by 'repo_helper'. Don't edit it directly.
 ---
-name: macOS Tests
+name: macOS
 
 on:
   push:
@@ -9,30 +9,36 @@ on:
 
 jobs:
   tests:
-    name: "Python ${{ matrix.python-version }}"
+    name: "Python ${{ matrix.config.python-version }}"
     runs-on: "macos-latest"
+    continue-on-error: ${{ matrix.config.experimental }}
     env:
       USING_COVERAGE: '3.6,3.7,3.8,3.9'
 
     strategy:
       fail-fast: False
       matrix:
-        python-version: ["3.6","3.7","3.8","3.9"]
+        config:
+          - {python-version: "3.6", testenvs: "py36,build", experimental: False}
+          - {python-version: "3.7", testenvs: "py37,build", experimental: False}
+          - {python-version: "3.8", testenvs: "py38,build", experimental: False}
+          - {python-version: "3.9", testenvs: "py39,build", experimental: False}
 
     steps:
       - name: Checkout 🛎️
         uses: "actions/checkout@v2"
+
       - name: Setup Python 🐍
         uses: "actions/setup-python@v2"
         with:
-          python-version: "${{ matrix.python-version }}"
+          python-version: "${{ matrix.config.python-version }}"
+
       - name: Install dependencies 🔧
         run: |
           python -VV
           python -m site
           python -m pip install --upgrade pip setuptools wheel
-          python -m pip install --upgrade tox tox-gh-actions virtualenv
-
+          python -m pip install --upgrade tox virtualenv
 
-      - name: "Run Tests for Python ${{ matrix.python-version }}"
-        run: "python -m tox"
+      - name: "Run Tests for Python ${{ matrix.config.python-version }}"
+        run: "python -m tox -e ${{ matrix.config.testenvs }}"
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -44,6 +44,9 @@ repos:
    rev: v1.7.0
    hooks:
     - id: python-no-eval
+    - id: rst-backticks
+    - id: rst-directive-colons
+    - id: rst-inline-touching-normal
 
  - repo: https://github.com/asottile/pyupgrade
    rev: v2.7.4

diff --git a/README.rst b/README.rst
@@ -18,34 +18,44 @@ octo-api
 	* - Docs
 	  - |docs| |docs_check|
 	* - Tests
-	  - |travis| |actions_windows| |actions_macos| |coveralls| |codefactor| |pre_commit_ci|
+	  - |actions_linux| |actions_windows| |actions_macos| |coveralls|
 	* - PyPI
 	  - |pypi-version| |supported-versions| |supported-implementations| |wheel|
 	* - Activity
-	  - |commits-latest| |commits-since| |maintained|
+	  - |commits-latest| |commits-since| |maintained| |pypi-downloads|
+	* - QA
+	  - |codefactor| |actions_flake8| |actions_mypy| |pre_commit_ci|
 	* - Other
-	  - |license| |language| |requires| |pre_commit|
+	  - |license| |language| |requires|
 
 .. |docs| image:: https://img.shields.io/readthedocs/octo-api/latest?logo=read-the-docs
-	:target: https://octo-api.readthedocs.io/en/latest/?badge=latest
+	:target: https://octo-api.readthedocs.io/en/latest
 	:alt: Documentation Build Status
 
 .. |docs_check| image:: https://github.com/domdfcoding/octo-api/workflows/Docs%20Check/badge.svg
 	:target: https://github.com/domdfcoding/octo-api/actions?query=workflow%3A%22Docs+Check%22
 	:alt: Docs Check Status
 
-.. |travis| image:: https://github.com/domdfcoding/octo-api/workflows/Linux%20Tests/badge.svg
-	:target: https://github.com/domdfcoding/octo-api/actions?query=workflow%3A%22Linux+Tests%22
+.. |actions_linux| image:: https://github.com/domdfcoding/octo-api/workflows/Linux/badge.svg
+	:target: https://github.com/domdfcoding/octo-api/actions?query=workflow%3A%22Linux%22
 	:alt: Linux Test Status
 
-.. |actions_windows| image:: https://github.com/domdfcoding/octo-api/workflows/Windows%20Tests/badge.svg
-	:target: https://github.com/domdfcoding/octo-api/actions?query=workflow%3A%22Windows+Tests%22
+.. |actions_windows| image:: https://github.com/domdfcoding/octo-api/workflows/Windows/badge.svg
+	:target: https://github.com/domdfcoding/octo-api/actions?query=workflow%3A%22Windows%22
 	:alt: Windows Test Status
 
-.. |actions_macos| image:: https://github.com/domdfcoding/octo-api/workflows/macOS%20Tests/badge.svg
-	:target: https://github.com/domdfcoding/octo-api/actions?query=workflow%3A%22macOS+Tests%22
+.. |actions_macos| image:: https://github.com/domdfcoding/octo-api/workflows/macOS/badge.svg
+	:target: https://github.com/domdfcoding/octo-api/actions?query=workflow%3A%22macOS%22
 	:alt: macOS Test Status
 
+.. |actions_flake8| image:: https://github.com/domdfcoding/octo-api/workflows/Flake8/badge.svg
+	:target: https://github.com/domdfcoding/octo-api/actions?query=workflow%3A%22Flake8%22
+	:alt: Flake8 Status
+
+.. |actions_mypy| image:: https://github.com/domdfcoding/octo-api/workflows/mypy/badge.svg
+	:target: https://github.com/domdfcoding/octo-api/actions?query=workflow%3A%22mypy%22
+	:alt: mypy status
+
 .. |requires| image:: https://requires.io/github/domdfcoding/octo-api/requirements.svg?branch=master
 	:target: https://requires.io/github/domdfcoding/octo-api/requirements/?branch=master
 	:alt: Requirements Status
@@ -92,9 +102,9 @@ octo-api
 .. |maintained| image:: https://img.shields.io/maintenance/yes/2020
 	:alt: Maintenance
 
-.. |pre_commit| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white
-	:target: https://github.com/pre-commit/pre-commit
-	:alt: pre-commit
+.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/octo-api
+	:target: https://pypi.org/project/octo-api/
+	:alt: PyPI - Downloads
 
 .. |pre_commit_ci| image:: https://results.pre-commit.ci/badge/github/domdfcoding/octo-api/master.svg
 	:target: https://results.pre-commit.ci/latest/github/domdfcoding/octo-api/master

diff --git a/doc-source/conf.py b/doc-source/conf.py
@@ -58,8 +58,6 @@
 templates_path = ["_templates"]
 html_static_path = ["_static"]
 source_suffix = ".rst"
-exclude_patterns = []
-
 master_doc = "index"
 suppress_warnings = ["image.nonlocal_uri"]
 pygments_style = "default"