Building a self-contained package

The generic-k8s-webhook can now be packaged into a self-contained
package, so this package can be executed without the need of installing
any extra dependency. To do so, we're leveraging pyinstaller.

Now, when we'll build a new release, we'll push this self-contained
package as part of the release.

Author: jordipiqueselles

.github/workflows/publish-artifacts.yaml

@@ -6,6 +6,28 @@ on:
       - '**'
 
 jobs:
+  build-release-pkg:
+    name: Builds and publishes a self-contained package to the release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout main
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Write version
+        run: ./scripts/insert-version-pyproject.sh ${{github.ref_name}}
+
+      - name: Build package
+        run: |
+          make pkg
+          mv ./dist/main ./generic-k8s-webhook-linux-${{github.ref_name}}
+
+      - name: Publish package
+        uses: softprops/action-gh-release@v2
+        with:
+          files: generic-k8s-webhook-linux-${{github.ref_name}}
+
   build-and-publish-to-ghcr:
     # Explicitly grant the `secrets.GITHUB_TOKEN` permissions.
     permissions:

.github/workflows/test-pr.yaml

@@ -29,6 +29,9 @@ jobs:
       - name: Install Python libraries
         run: poetry install
 
+      - name: Build self-contained package
+        run: make pkg
+
       - name: Linter
         run: make lint
 

Makefile

@@ -41,6 +41,10 @@ check-pyproject:
 docker:
 	docker build -t generic-k8s-webhook:latest .
 
+.PHONY: pkg
+pkg: build
+	poetry run pyinstaller ./generic_k8s_webhook/main.py --onefile --recursive-copy-metadata generic_k8s_webhook
+
 all-tests: check-pyproject lint unittests docker
 
 all-tests-seq: | check-pyproject lint unittests docker

poetry.lock

@@ -7,7 +7,7 @@ authors = ["jordi <[email protected]>"]
 license = "Apache License"
 
 [tool.poetry.dependencies]
-python = "^3.11"
+python = ">=3.11,<3.13"
 PyYAML = "^6.0"
 jsonpatch = "^1.33"
 requests = "^2.31.0"
@@ -23,6 +23,7 @@ isort = "^5.12.0"
 black = "^23.3.0"
 pylint = "^2.17.4"
 pytest-cov = "^5.0.0"
+pyinstaller = "^6.9.0"
 
 [tool.isort]
 line_length = 120