build and upload executables created by PyInstaller

- create release on tag push
- build executables by PyInstaller:
    - extract_otp_secrets_linux_x86_64 (glibc 2.28)
    - extract_otp_secrets_win_x86_64.exe
    - extract_otp_secrets_macos_x86_64 (untested)
- add --version
- build linux executable in docker container
- update README
    - add TOC
    - improve badges
    - add PyInstaller section
- docker
    - build BASE_IMAGE as ARG
    - copy only required files to image
    - add .alias
- build.sh
    - fix clean
    - fix generate results
    - generate TOC

Author: scito

.github/workflows/ci.yml

@@ -7,6 +7,8 @@ name: tests
 
 on:
   push:
+    paths-ignore:
+      - 'docs/**'
   # pull_request:
   schedule:
     # Run daily on default branch
@@ -29,6 +31,7 @@ jobs:
         uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
+          check-latest: false
       - name: Install zbar shared lib for QReader (Linux)
         if: runner.os == 'Linux'
         run: |

.github/workflows/ci_docker.yml

@@ -11,13 +11,19 @@ name: docker
 on:
   # run it on push to the default repository branch
   push:
+    paths-ignore:
+      - 'docs/**'
+    tags-ignore:
+      - '**'
+    # branches is needed if tags-ignore is used
+    branches:
+      - '**'
   schedule:
     # Run weekly on default branch
     - cron: '47 3 * * 6'
 
 jobs:
-  # define job to build and publish docker image
-  build-and-push-docker-image:
+  build-and-push-docker-debian-image:
     name: Build Docker image and push to repositories
     # run only when code is compiling and tests are passing
     runs-on: ubuntu-latest
@@ -57,40 +63,94 @@ jobs:
           username: ${{ github.actor }}
           password: ${{ secrets.GHCR_IO_TOKEN }}
 
-      - name: "no_qr_reader: Build image and push to Docker Hub and GitHub Container Registry"
-        id: docker_build_only_txt
-        uses: docker/build-push-action@v2
+      - name: "qr_reader: Build image and push to Docker Hub and GitHub Container Registry"
+        id: docker_build_qr_reader_latest
+        uses: docker/build-push-action@v3
         with:
-          # relative path to the place where source code with Dockerfile is located
           platforms: linux/amd64,linux/arm64
+          # relative path to the place where source code with Dockerfile is located
+          # TODO file:, move to docker/
           context: .
-          file: Dockerfile_only_txt
+          file: Dockerfile
           # builder: ${{ steps.buildx.outputs.name }}
           # Note: tags has to be all lower-case
+          pull: true
           tags: |
-            scit0/extract_otp_secrets:latest-only-txt
-            ghcr.io/scito/extract_otp_secrets:latest-only-txt
+            scit0/extract_otp_secrets:latest
+            scit0/extract_otp_secrets:bullseye
+            ghcr.io/scito/extract_otp_secrets:latest
+            ghcr.io/scito/extract_otp_secrets:bullseye
           # build on feature branches, push only on master branch
           push: ${{ github.ref == 'refs/heads/master' }}
-          build-args: |
-            RUN_TESTS=true
 
-      - name: "qr_reader: Build image and push to Docker Hub and GitHub Container Registry"
-        id: docker_build_qr_reader
-        uses: docker/build-push-action@v2
+      - name: Image digest
+        # TODO upload digests to assets
+        run: |
+          echo "extract_otp_secrets: ${{ steps.docker_build_qr_reader_latest.outputs.digest }}"
+
+  build-and-push-docker-alpine-image:
+    name: Build Docker image and push to repositories
+    # run only when code is compiling and tests are passing
+    runs-on: ubuntu-latest
+
+    # steps to perform in job
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      # avoid building if there are testing errors
+      - name: Run smoke test
+        run: |
+          sudo apt-get install -y libzbar0
+          python -m pip install --upgrade pip
+          pip install -U -r requirements-dev.txt
+          pip install -U .
+          pytest
+
+      - name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+
+      # setup Docker build action
+      - name: Set up Docker Buildx
+        id: buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to DockerHub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Login to Github Packages
+        uses: docker/login-action@v2
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GHCR_IO_TOKEN }}
+
+      - name: "only_txt: Build image and push to Docker Hub and GitHub Container Registry"
+        id: docker_build_only_txt
+        uses: docker/build-push-action@v3
         with:
-          platforms: linux/amd64,linux/arm64
           # relative path to the place where source code with Dockerfile is located
+          platforms: linux/amd64,linux/arm64
           context: .
+          file: Dockerfile_only_txt
           # builder: ${{ steps.buildx.outputs.name }}
           # Note: tags has to be all lower-case
+          pull: true
           tags: |
-            scit0/extract_otp_secrets:latest
-            ghcr.io/scito/extract_otp_secrets:latest
+            scit0/extract_otp_secrets:only-txt
+            scit0/extract_otp_secrets:alpine
+            ghcr.io/scito/extract_otp_secrets:only-txt
+            ghcr.io/scito/extract_otp_secrets:alpine
           # build on feature branches, push only on master branch
           push: ${{ github.ref == 'refs/heads/master' }}
+          build-args: |
+            RUN_TESTS=true
+
 
       - name: Image digest
+        # TODO upload digests to assets
         run: |
-          echo "extract_otp_secrets: ${{ steps.docker_build_qr_reader.outputs.digest }}"
-          echo "extract_otp_secrets_only_txt: ${{ steps.docker_build_only_txt.outputs.digest }}"
+          echo "extract_otp_secrets:only-txt: ${{ steps.docker_build_only_txt.outputs.digest }}"