move requirements assests to lockfiles zip

Author: gilesknap

.containerignore

@@ -0,0 +1,10 @@
+build/
+dist/
+.mypy_cache
+.tox
+.venv*
+venv*
+.devcontainer.json
+.pre-commit-config.yaml
+.vscode
+README.rst

.dockerignore

@@ -110,6 +110,7 @@ jobs:
         run: |
           docker run --name test build bash /project/.github/workflows/container_tests.sh
           docker cp test:/project/dist .
+          docker cp test:/project/lockfiles .
           docker cp test:/project/cov.xml .
 
       - name: Upload coverage to Codecov
@@ -141,6 +142,12 @@ jobs:
           name: dist
           path: dist
 
+      - name: Upload lock files
+        uses: actions/upload-artifact@v3
+        with:
+          name: lockfiles
+          path: lockfiles
+
   release:
     # upload to PyPI and make a release on every tag
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
@@ -156,7 +163,9 @@ jobs:
         uses: softprops/action-gh-release@1e07f4398721186383de40550babbdf2b84acfc5 # v0.1.14
         with:
           prerelease: ${{ contains(github.ref_name, 'a') || contains(github.ref_name, 'b') || contains(github.ref_name, 'rc') }}
-          files: dist/*
+          files: |
+            dist/
+            lockfiles/
           generate_release_notes: true
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/code.yml

@@ -6,7 +6,8 @@ source /venv/bin/activate
 
 touch requirements_dev.txt
 pip install -r requirements_dev.txt -e .[dev]
-pip freeze --exclude-editable > dist/requirements_dev.txt
+mkdir -p lockfiles
+pip freeze --exclude-editable > lockfiles/requirements_dev.txt
 
 pipdeptree
 

.github/workflows/container_tests.sh

@@ -17,29 +17,33 @@ RUN apt-get update && apt-get upgrade -y && \
     && busybox --install
 
 COPY . /project
+WORKDIR /project
 
-RUN cd /project && \
-    pip install --upgrade pip build && \
+# make the wheel outside of the venv so 'build' does not dirty requirements.txt
+RUN pip install --upgrade pip build && \
     export SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct) && \
     python -m build --sdist --wheel && \
     touch requirements.txt
 
+# set up a virtual environment and put it in PATH
 RUN python -m venv /venv
 ENV PATH=/venv/bin:$PATH
 ENV TOX_DIRECT=1
 
-RUN cd /project && \
-    pip install --upgrade pip && \
+# install the wheel and generate the requirements file
+RUN pip install --upgrade pip && \
     pip install -r requirements.txt dist/*.whl && \
-    pip freeze  > dist/requirements.txt && \
+    mkdir -p lockfiles && \
+    pip freeze  > lockfiles/requirements.txt && \
     # we don't want to include our own wheel in requirements - remove with sed
     # and replace with a comment to avoid a zero length asset upload later
-    sed -i '/file:/s/^/# Requirements for /' dist/requirements.txt
+    sed -i '/file:/s/^/# Requirements for /' lockfiles/requirements.txt
 
 FROM python:3.10-slim as runtime
 
 # Add apt-get system dependecies for runtime here if needed
 
+# copy the virtual environment from the build stage and put it in PATH
 COPY --from=build /venv/ /venv/
 ENV PATH=/venv/bin:$PATH