Code Review Changes

Added the remote containers extension (`ms-vscode-remote.remote-containers`) to the recommended extensions json for VSCode

Bump actions/setup-python from 2 to 4

Bumps [actions/setup-python](https://github.com/actions/setup-python) from 2 to 4.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](actions/setup-python@v2...v4)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <[email protected]>

Updates from code review.

updates from review

system python for lint

better release files

final review changes

add test of runtime container

make docs CI always run

improve container_tests

simplifying CI

fix broken links

adding docs delete action

adding docs delete action

fix remote repo action firing

fix remote repo action firing

Author: garryod

.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.
@@ -21,12 +21,10 @@
         "ms-python.vscode-pylance"
     ],
     // 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'",
+    "initializeCommand": "bash -c 'for i in $HOME/.inputrc; do [ -f $i ] || touch $i; done'",
     "runArgs": [
-        "--privileged",
         "--net=host",
         "-v=${localEnv:HOME}/.ssh:/root/.ssh",
-        "-v=${localEnv:HOME}/.bashrc_dev:/root/.bashrc",
         "-v=${localEnv:HOME}/.inputrc:/root/.inputrc"
     ],
     "mounts": [

.gitattributes

@@ -5,31 +5,31 @@ 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:
     # pull requests are a duplicate of a branch push if within the same repo.
-    if: github.event_name != 'pull_request' || github.event.pull_request.repository == github.repository
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout
         uses: actions/checkout@v2
 
-      - uses: actions/setup-python@v2
+      - name: Setup python
+        uses: actions/setup-python@v4
         with:
           python-version: "3.10"
 
       - name: Lint
         run: |
-          touch requirements_dev.txt
-          python -m pip install --upgrade pip
-          python -m pip install -r requirements_dev.txt -e .[dev]
+          touch requirements_dev.txt requirements.txt
+          pip install -r requirements.txt -r requirements_dev.txt -e .[dev]
           tox -e pre-commit,mypy
 
   test:
-    if: github.event_name != 'pull_request' || github.event.pull_request.repository == github.repository
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository
     strategy:
       fail-fast: false
       matrix:
@@ -59,13 +59,13 @@ 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
 
   container:
-    if: github.event_name != 'pull_request' || github.event.pull_request.repository == github.repository
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository
     runs-on: ubuntu-latest
     permissions:
       contents: read
@@ -77,14 +77,6 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: Cache Docker layers
-        uses: actions/cache@v3
-        with:
-          path: /tmp/.buildx-cache
-          key: ${{ runner.os }}-buildx-${{ github.sha }}
-          restore-keys: |
-            ${{ runner.os }}-buildx-
-
       - name: Log in to GitHub Docker Registry
         if: github.event_name != 'pull_request'
         uses: docker/login-action@v2
@@ -112,16 +104,19 @@ jobs:
           tags: build:latest
           context: .
           target: build
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache
           load: true
 
       - 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
@@ -130,44 +125,34 @@ jobs:
           tags: ${{ steps.meta.outputs.tags }}
           context: .
           labels: ${{ steps.meta.outputs.labels }}
-          cache-from: type=local,src=/tmp/.buildx-cache
-          cache-to: type=local,dest=/tmp/.buildx-cache
+
+      - name: Check runtime
+        run: for i in ${{ steps.meta.outputs.tags }}; do docker run ${i} --version; done
 
       - name: Upload build files
         uses: actions/upload-artifact@v3
         with:
-          name: build_files
-          path: |
-            dist
-            requirements.txt
-            requirements_dev.txt
+          name: dist
+          path: dist/*
 
   sdist:
     needs: container
     runs-on: ubuntu-latest
 
     steps:
-      - name: Checkout
-        uses: actions/checkout@v2
-
-      - uses: actions/setup-python@v2
-        with:
-          python-version: "3.10"
-
       - uses: actions/download-artifact@v3
 
       - name: Install sdist in a venv and check cli works
         # ${GITHUB_REPOSITORY##*/} is the repo name without org
         # Replace this with the cli command if different to the repo name
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install build_files/dist/*.gz
+          pip install dist/*.gz
           ${GITHUB_REPOSITORY##*/} --version
 
   release:
     # upload to PyPI and make a release on every tag
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
-    needs: [lint, container]
+    needs: container
     runs-on: ubuntu-latest
 
     steps:
@@ -179,13 +164,13 @@ jobs:
         uses: softprops/action-gh-release@1e07f4398721186383de40550babbdf2b84acfc5 # v0.1.14
         with:
           files: |
-            build_files/*
+            dist/*
           generate_release_notes: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Publish to PyPI
         env:
           TWINE_USERNAME: __token__
-          TWINE_PASSWORD: ${{ secrets.pypi_token }}
-        run: pipx run twine upload artifacts/dist/*
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+        run: pipx run twine upload dist/*/whl dist/*.tar.gz

.github/workflows/code.yml

@@ -0,0 +1,13 @@
+#!/bin/bash
+set -x
+
+cd /project
+source /venv/bin/activate
+
+touch requirements_dev.txt
+pip install -r requirements_dev.txt -e .[dev]
+pip freeze --exclude-editable > dist/requirements_dev.txt
+
+pipdeptree
+
+pytest tests

.github/workflows/container_tests.sh

@@ -2,21 +2,25 @@ name: Docs CI
 
 on:
   push:
-    tags:
-      - "*"
   pull_request:
 
 jobs:
   docs:
+    if: github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name != github.repository
     strategy:
       fail-fast: false
       matrix:
-        os: ["ubuntu-latest"]
         python: ["3.10"]
 
     runs-on: ubuntu-latest
 
     steps:
+      - name: Dump github context
+        run: echo "$GITHUB_CONTEXT"
+        shell: bash
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+
       - name: Avoid git conflicts when tag and branch pushed at same time
         if: startsWith(github.ref, 'refs/tags')
         run: sleep 60
@@ -44,7 +48,7 @@ jobs:
         run: tox -e docs
 
       - name: Move to versioned directory
-        # e.g. master or 0.1.2
+        # e.g. main or 0.1.2
         run: mv build/html ".github/pages/${GITHUB_REF##*/}"
 
       - name: Write versions.txt

.github/workflows/docs.yml

@@ -0,0 +1,41 @@
+name: Docs Cleanup CI
+
+# delete branch documentation when a branch is deleted
+# also allow manually deleting a documentation version
+on:
+  delete:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "documentation version to DELETE"
+        required: true
+        type: string
+
+jobs:
+  remove:
+    if: github.event.ref_type == 'branch' || github.event_name == 'workflow_dispatch'
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: checkout
+        uses: actions/checkout@v2
+        with:
+          ref: gh-pages
+
+      - name: removing documentation for branch ${{ github.event.ref }}
+        if: ${{ github.event_name != 'workflow_dispatch' }}
+        run: echo "remove_me=${{ github.event.ref }}" >> $GITHUB_ENV
+
+      - name: manually removing documentation version ${{ github.event.inputs.version }}
+        if: ${{ github.event_name == 'workflow_dispatch' }}
+        run: echo "remove_me=${{ github.event.inputs.version }}" >> $GITHUB_ENV
+
+      - name: update index and push changes
+        run: |
+          echo removing redundant documentation version ${{ env.remove_me }}
+          rm -r ${{ env.remove_me }}
+          sed -i /${{ env.remove_me }}/d versions.txt
+          git config --global user.name 'GitHub Actions Docs Cleanup CI'
+          git config --global user.email '[email protected]'
+          git commit -am"removing redundant docs version ${{ env.remove_me }}" 
+          git push

.github/workflows/docs_clean.yml

@@ -3,23 +3,18 @@ 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:
     strategy:
       fail-fast: false
       matrix:
-        os: ["ubuntu-latest"]
         python: ["3.10"]
 
     runs-on: ubuntu-latest
 
     steps:
-      - name: Avoid git conflicts when tag and branch pushed at same time
-        if: startsWith(github.ref, 'refs/tags')
-        run: sleep 60
-
       - name: Checkout
         uses: actions/checkout@v2
         with:

.github/workflows/linkcheck.yml

@@ -60,10 +60,8 @@ docs/_build/
 # PyBuilder
 target/
 
-# DLS build dir and virtual environment
-/prefix/
-/venv/
-/lightweight-venv/
-/installed.files
+# likely venv names
 .venv*
+venv*
+