updates from review

Author: gilesknap

.containerignore

@@ -4,3 +4,4 @@ dist/
 .mypy_cache
 .tox
 .venv*
+venv*

.devcontainer.json

@@ -12,7 +12,7 @@
     },
     // Set *default* container specific settings.json values on container create.
     "settings": {
-        "python.defaultInterpreterPath": "/usr/local/bin/python",
+        "python.defaultInterpreterPath": "/venv/bin/python",
         "python.linting.enabled": true
     },
     // Add the IDs of extensions you want installed when the container is created.
@@ -23,7 +23,6 @@
     // Make sure the files we are mapping into the container exist on the host
     "initializeCommand": "bash -c 'for i in $HOME/.inputrc $HOME/.bashrc_dev; do [ -f $i ] || touch $i; done'",
     "runArgs": [
-        "--privileged",
         "--net=host",
         "-v=${localEnv:HOME}/.ssh:/root/.ssh",
         "-v=${localEnv:HOME}/.bashrc_dev:/root/.bashrc",

.gitattributes

@@ -5,7 +5,7 @@ on:
   pull_request:
   schedule:
     # Run every Monday at 8am to check latest versions of dependencies
-    - cron: "0 8 * * MON"
+    - cron: "0 8 * * WED"
 
 jobs:
   lint:
@@ -23,9 +23,9 @@ jobs:
 
       - name: Lint
         run: |
-          touch requirements_dev.txt
+          touch requirements_dev.txt requirements.txt
           python -m pip install --upgrade pip
-          python -m pip install -r requirements_dev.txt -e .[dev]
+          python -m pip install -r requirements.txt -r requirements_dev.txt -e .[dev]
           tox -e pre-commit,mypy
 
   test:
@@ -59,7 +59,7 @@ jobs:
         run: pytest tests
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v2
+        uses: codecov/codecov-action@v3
         with:
           name: ${{ matrix.python }}/${{ matrix.os }}
           files: cov.xml
@@ -82,8 +82,7 @@ jobs:
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-buildx-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-buildx-
+          restore-keys: ${{ runner.os }}-buildx-
 
       - name: Log in to GitHub Docker Registry
         if: github.event_name != 'pull_request'
@@ -118,10 +117,17 @@ jobs:
 
       - name: Run tests in the container locked with requirements_dev.txt
         run: |
-          docker run --name test build bash /project/tests/container_tests.sh
+          docker run --name test build bash /project/.github/workflows/container_tests.sh
           docker cp test:/project/dist .
           docker cp test:/project/requirements.txt .
           docker cp test:/project/requirements_dev.txt .
+          docker cp test:/project/cov.xml .
+
+      - name: Upload coverage to Codecov
+        uses: codecov/codecov-action@v3
+        with:
+          name: 3.10-locked/ubuntu-latest
+          files: cov.xml
 
       - name: Build runtime image
         uses: docker/build-push-action@v3
@@ -147,9 +153,6 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
       - uses: actions/setup-python@v4
         with:
           python-version: "3.10"

.github/workflows/code.yml

@@ -3,7 +3,7 @@ name: Link Check
 on:
   schedule:
     # Run every Monday at 8am to check URL links still resolve
-    - cron: "0 8 * * MON"
+    - cron: "0 8 * * WED"
 
 jobs:
   docs:

tests/container_tests.sh .github/workflows/container_tests.shtests/container_tests.sh renamed to .github/workflows/container_tests.sh

@@ -61,7 +61,7 @@ The code in this repository conforms to standards set by the following tools:
 - isort_ for import ordering
 - mypy_ for static type checking
 
-flake8 and black be run by pre-commit_. You can run the above checks on
+flake8 and black and isort are run by pre-commit_. You can run the above checks on
 all files with this command::
 
     $ tox -e pre-commit,mypy
@@ -125,7 +125,7 @@ Release Process
 
 To make a new release, please follow this checklist:
 
-- Choose a new PEP440 compliant release number
+- Choose a new PEP440 compliant release number (see https://peps.python.org/pep-0440/)
 - Go to the GitHub release_ page
 - Choose ``Draft New Release``
 - Click ``Choose Tag`` and supply the new tag you chose (click create new tag)

.github/workflows/linkcheck.yml

@@ -31,6 +31,7 @@ RUN cd /project && \
     pip install --upgrade pip && \
     pip install -r requirements.txt dist/*.whl && \
     pip freeze  > requirements.txt && \
+    # we don't want to include our own wheel in requirements - remove with sed
     sed -i '/file:\/\//d' requirements.txt
 
 FROM python:3.10-slim as runtime

CONTRIBUTING.rst

@@ -8,4 +8,4 @@ Explanation of how the library works and why it works that way.
 .. toctree::
     :caption: Explanations
 
-    explanations/why-is-something-so
+    explanations/decisions

Dockerfile

@@ -0,0 +1,17 @@
+.. This Source Code Form is subject to the terms of the Mozilla Public
+.. License, v. 2.0. If a copy of the MPL was not distributed with this
+.. file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+Architectural Decision Records
+==============================
+
+We record major architectural decisions in Architecture Decision Records (ADRs),
+as `described by Michael Nygard
+<http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions>`_.
+Below is the list of our current ADRs.
+
+.. toctree::
+    :maxdepth: 1
+    :glob:
+
+    decisions/*