applying changes for pip based workflow

Author: gilesknap

.github/workflows/code.yml

@@ -19,38 +19,36 @@ jobs:
   lint:
     runs-on: "ubuntu-latest"
     steps:
-      - name: Run black, flake8, mypy
-        uses: dls-controls/pipenv-run-action@v1
-        with:
-          pipenv-run: lint
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Lint
+        run: |
+          pip install --user .[dev]
+          tox -e pre-commit,mypy
 
   wheel:
     strategy:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest"]
-        python: ["3.7"]
+        python: ["3.8"]
 
     runs-on: ${{ matrix.os }}
     steps:
       - uses: actions/checkout@v2
-        with:
-          fetch-depth: 0
 
       - name: Create Sdist and Wheel
         # Set SOURCE_DATE_EPOCH from git commit for reproducible build
         # https://reproducible-builds.org/
-        # Set group writable and umask to do the same to match inside DLS
         run: |
-          chmod -R g+w .
-          umask 0002
           SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct) pipx run build --sdist --wheel
 
       - name: Upload Wheel and Sdist as artifacts
         uses: actions/upload-artifact@v2
         with:
           name: dist
-          path: dist/*
+          path: dist
 
       - name: Install minimum python version
         uses: actions/setup-python@v2
@@ -67,35 +65,68 @@ jobs:
       fail-fast: false
       matrix:
         os: ["ubuntu-latest"] # can add windows-latest, macos-latest
-        python: ["3.7", "3.8", "3.9"]
-        pipenv: ["skip-lock"]
+        python: ["3.8", "3.9", "3.10"]
+        lock: [false]
 
         include:
-          # Add an extra Python3.7 runner to use the lockfile
+          # Add an extra Python3.10 runner to use the lockfile
           - os: "ubuntu-latest"
-            python: "3.7"
-            pipenv: "deploy"
+            python: "3.10"
+            lock: true
 
     runs-on: ${{ matrix.os }}
     env:
       # https://github.com/pytest-dev/pytest/issues/2042
       PY_IGNORE_IMPORTMISMATCH: "1"
+      # enable QT tests with no X Display
+      QT_QPA_PLATFORM: "offscreen"
 
     steps:
-      - name: Setup repo and test
-        uses: dls-controls/pipenv-run-action@v1
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Setup python ${{ matrix.python }}
+        uses: actions/setup-python@v2
         with:
           python-version: ${{ matrix.python }}
-          pipenv-install: --dev --${{ matrix.pipenv }}
-          allow-editable-installs: ${{ matrix.pipenv == 'deploy' }}
-          pipenv-run: tests
+
+      - name: Install with locked dependencies
+        if: matrix.lock
+        run: |
+          touch requirements.txt requirements_dev.txt
+          pip install -r requirements.txt -e .
+          pip freeze --exclude-editable > requirements.txt
+          pip install -r requirements_dev.txt -e .[dev]
+          pip freeze --exclude-editable > requirements_dev.txt
+
+      - name: Install with latest dependencies
+        if: ${{ ! matrix.lock }}
+        run: pip install -e .[dev]
+
+      - name: Run tests
+        run: pytest tests
+
+      - name: Create requirements_dev.txt
+        run: |
+          pip freeze --exclude-editable > requirements_dev.txt
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v2
         with:
-          name: ${{ matrix.python }}/${{ matrix.os }}/${{ matrix.pipenv }}
+          name: ${{ matrix.python }}/${{ matrix.os }}/${{ matrix.lock }}
           files: cov.xml
 
+      - name: Upload build files
+        if: matrix.lock
+        uses: actions/upload-artifact@v2
+        with:
+          name: buildfiles
+          path: |
+            requirements.txt
+            requirements_dev.txt
+
   release:
     needs: [lint, wheel, test]
     runs-on: ubuntu-latest
@@ -104,15 +135,16 @@ jobs:
     steps:
       - uses: actions/download-artifact@v2
         with:
-          name: dist
-          path: dist
+          path: artifacts
 
       - name: Github Release
         # We pin to the SHA, not the tag, for security reasons.
         # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
         uses: softprops/action-gh-release@1e07f4398721186383de40550babbdf2b84acfc5 # v0.1.14
         with:
-          files: dist/*
+          files: |
+            artifacts/dist/*
+            artifacts/buildfiles/*
           generate_release_notes: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -121,4 +153,62 @@ jobs:
         env:
           TWINE_USERNAME: __token__
           TWINE_PASSWORD: ${{ secrets.pypi_token }}
-        run: pipx run twine upload dist/*
+        run: pipx run twine upload artifacts/dist/*
+
+  make-container:
+    needs: [lint, wheel, test]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - uses: actions/download-artifact@v2
+        with:
+          name: dist
+          path: dist
+
+      - name: Cache Docker layers
+        uses: actions/cache@v2
+        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@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ghcr.io/${{ github.repository }}
+          tags: |
+            type=ref,event=branch
+            type=ref,event=tag
+            type=raw,value=latest
+
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v1
+
+      - name: Build runtime image
+        uses: docker/build-push-action@v2
+        with:
+          file: .devcontainer/Dockerfile
+          context: .
+          push: ${{ github.event_name != 'pull_request' }}
+          build-args: BASE=python:3.10-slim
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          cache-from: type=local,src=/tmp/.buildx-cache
+          cache-to: type=local,dest=/tmp/.buildx-cache

.github/workflows/docs.yml

@@ -12,28 +12,47 @@ on:
 
 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: Install python version
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python }}
+
       - name: Install Packages
         # Can delete this if you don't use graphviz in your docs
         run: sudo apt-get install graphviz
 
-      - name: Build docs
-        uses: dls-controls/pipenv-run-action@v1
+      - name: checkout
+        uses: actions/checkout@v2
         with:
-          pipenv-run: docs
+          fetch-depth: 0
+
+      - name: Install dependencies
+        run: |
+          touch requirements_dev.txt
+          pip install -r requirements_dev.txt -e .[dev]
+
+      - name: Build docs
+        run: tox -e docs
 
       - name: Move to versioned directory
-        # e.g. main or 0.1.2
+        # e.g. master or 0.1.2
         run: mv build/html ".github/pages/${GITHUB_REF##*/}"
 
       - name: Write versions.txt
-        run: pipenv run sphinx_rtd_theme_github_versions .github/pages
+        run: sphinx_rtd_theme_github_versions .github/pages
 
       - name: Publish Docs to gh-pages
         if: github.event_name == 'push'

.github/workflows/linkcheck.yml

@@ -7,10 +7,33 @@ on:
 
 jobs:
   docs:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: ["ubuntu-latest"]
+        python: ["3.10"]
+
     runs-on: ubuntu-latest
 
     steps:
-      - name: Build docs
-        uses: dls-controls/pipenv-run-action@v1
+      - 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:
+          fetch-depth: 0
+
+      - name: Install python version
+        uses: actions/setup-python@v2
         with:
-          pipenv-run: docs -b linkcheck
+          python-version: ${{ matrix.python }}
+
+      - name: Install dependencies
+        run: |
+          touch requirements_dev.txt
+          pip install -r requirements_dev.txt -e .[dev]
+
+      - name: Check links
+        run: tox -e docs -- -b linkcheck

.gitignore

@@ -8,6 +8,7 @@ __pycache__/
 # Distribution / packaging
 .Python
 env/
+.venv
 build/
 develop-eggs/
 dist/
@@ -22,6 +23,7 @@ var/
 *.egg-info/
 .installed.cfg
 *.egg
+**/_version.py
 
 # PyInstaller
 #  Usually these files are written by a python script from a template

.gitremotes

@@ -1 +1 @@
-github [email protected]:dls-controls/dls-python3-skeleton.git
+github [email protected]:epics-containers/python3-pip-skeleton.git

.pre-commit-config.yaml

@@ -12,19 +12,12 @@ repos:
         name: Run black
         stages: [commit]
         language: system
-        entry: pipenv run black --check --diff
+        entry: black --check --diff
         types: [python]
 
       - id: flake8
         name: Run flake8
         stages: [commit]
         language: system
-        entry: pipenv run flake8
+        entry: flake8
         types: [python]
-
-      - id: mypy
-        name: Run mypy
-        stages: [commit]
-        language: system
-        entry: pipenv run mypy src tests
-        pass_filenames: false