Improved release workflow (#35)

* further refined package discovery and removed bump2version

* fixed more import errors

* Created pre-release and tag push workflows

* tag pushes now create a release and push to tag

* bump version

* merged pre-release and tag pushed

* Fixed pre-release workflow

* another fix for pre-release

* fixed pre-merge workflow

* fixed pre-release workflow

* Fixed pre-release workflow

* bumped version

* fixed pre-release workflow

* removed metadata step from pre-merge and pre-release

* bumped version

Author: levmckinney

.github/workflows/pre-merge.yml

@@ -4,8 +4,6 @@ on:
   pull_request:
     branches: [ "main" ]
 
-env:
-  IMAGE_NAME: ${{ github.repository }}
 
 jobs:
   pre-commit:
@@ -24,11 +22,6 @@ jobs:
     steps:
       - name: Checkout code
         uses: actions/checkout@v2
-      - name: Extract metadata (tags, labels) for Docker
-        id: meta
-        uses: docker/metadata-action@v4
-        with:
-          images: ${{ env.IMAGE_NAME }}
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v2
         with:
@@ -38,12 +31,11 @@ jobs:
         with:
           context: .
           target: test
-          tags: ${{ steps.meta.outputs.tags }}
-          cache-from: type=gha
+          tags: unit_test_img:latest
       - name: Run tests
         run: |
           docker run \
             -v $PWD:/workspace \
             --pull=never \
-            --rm ${{ steps.meta.outputs.tags }} \
+            --rm unit_test_img:latest \
             pytest

.github/workflows/pre-release.yml

@@ -0,0 +1,98 @@
+name: Create release
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+
+jobs:
+  validate-tag:
+    name: Validate tag
+    runs-on: 'ubuntu-latest'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.9'
+      - name: Install toml
+        run: pip install toml
+      - name: Add version from pyproject.toml to environment vars
+        run: |
+          PROJECT_VERSION=$(python -c "import toml; print(toml.load('pyproject.toml')['project']['version'])")
+          echo "PROJECT_VERSION=$PROJECT_VERSION" >> $GITHUB_ENV
+      - name: Check if tag version matches project version
+        run: |
+          TAG=$(git describe HEAD --tags --abbrev=0)
+          echo $TAG
+          echo $PROJECT_VERSION
+          if [[ "$TAG" != "v$PROJECT_VERSION" ]]; then exit 1; fi
+  build-and-test:
+    name: "Build Docker image and run smoke test"
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+        with:
+          driver: docker
+      - name: Build Docker image
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          target: prod
+          tags: smoke_test_img:latest
+      - name: Run tests
+        run: >-
+          docker run
+          --pull=never
+          --rm smoke_test_img:latest
+          tuned-lens --help
+  build-n-publish-python-package:
+    name: Build and publish Python distributions to TestPyPI
+    runs-on: ubuntu-latest
+    needs:
+      - build-and-test
+      - validate-tag
+    steps:
+    - uses: actions/checkout@master
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v3
+      with:
+        python-version: "3.10"
+    - name: Install pypa/build
+      run: >-
+        python -m
+        pip install
+        build
+        --user
+    - name: Build a binary wheel and a source tarball
+      run: >-
+        python -m
+        build
+        --sdist
+        --wheel
+        --outdir dist/
+        .
+    - name: Publish distribution to Test PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1
+      with:
+        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+        repository_url: https://test.pypi.org/legacy/
+  create-draft-release:
+    name: Create a draft release
+    runs-on: ubuntu-latest
+    needs:
+      - build-and-test
+      - build-n-publish-python-package
+    steps:
+    - name: Create a draft release
+      uses: softprops/action-gh-release@v1
+      with:
+          draft: true

.github/workflows/publish.yml

@@ -1,9 +1,8 @@
 name: Publish to package to PyPI and Docker image to GitHub packages
 
 on:
-  push:
-    tags:
-      - "v*"
+  release:
+    types: [published]
 
 env:
   REGISTRY: ghcr.io
@@ -49,7 +48,7 @@ jobs:
           cache-to: type=gha,mode=max
 
   build-n-publish-python-package:
-    name: Build and publish Python distributions to PyPI and TestPyPI
+    name: Build and publish Python distributions to PyPI
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@master
@@ -71,11 +70,6 @@ jobs:
         --wheel
         --outdir dist/
         .
-    - name: Publish distribution to Test PyPI
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        password: ${{ secrets.TEST_PYPI_API_TOKEN }}
-        repository_url: https://test.pypi.org/legacy/
     - name: Publish distribution to PyPI
       if: startsWith(github.ref, 'refs/tags')
       uses: pypa/gh-action-pypi-publish@release/v1

pyproject.toml

@@ -20,7 +20,7 @@ dependencies = [
     "transformers",
     "huggingface_hub>=0.12.1",
 ]
-version = "0.0.2"
+version = "0.0.3"
 
 [project.optional-dependencies]
 dev = [