Merge pull request #160 from ManiMatter/dev

various refinements

.github/workflows/build.yml

@@ -0,0 +1,140 @@
+name: Test, Build, Deploy
+
+on:
+  push:
+    branches:
+      - '*'
+    paths-ignore:
+      - '**/*.md'
+  pull_request:
+    branches:
+      - '*' 
+    paths-ignore:
+      - '**/*.md'
+  workflow_dispatch: 
+  create:
+    branches:
+      - '*'
+
+jobs:
+  validate-branch-name:
+    runs-on: ubuntu-latest
+    outputs:
+      valid_branch_name: ${{ steps.validate.outputs.valid_branch_name }}
+    steps:
+      - name: Validate Branch Name
+        id: validate
+        run: |
+          BRANCH_NAME="${{ github.ref_name }}"
+          if [[ "$BRANCH_NAME" =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
+            echo "::error::Branch name '$BRANCH_NAME' is not allowed. Branch names using versioning names like 'v1.2.3' are prohibited."
+            echo "valid_branch_name=false" >> $GITHUB_OUTPUT
+            exit 1
+          else
+            echo "Branch name '$BRANCH_NAME' is valid."
+            echo "valid_branch_name=true" >> $GITHUB_OUTPUT
+          fi
+
+  unit-tests:
+    needs: validate-branch-name
+    if: needs.validate-branch-name.outputs.valid_branch_name == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.10.13'
+      - name: Install testing dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r docker/requirements.txt
+      - name: Run unit tests
+        run: |
+          python3 -m pytest -o log_cli=false
+
+  build:
+    needs: unit-tests
+    runs-on: ubuntu-latest
+    if: github.event_name == 'push'
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Store short Commit ID in env variable
+        id: vars
+        run: |
+          calculatedSha=$(git rev-parse --short ${{ github.sha }})
+          echo "SHORT_COMMIT_ID=$calculatedSha" >> $GITHUB_ENV
+
+      - name: Determine Docker image tag
+        id: setversion
+        run: |
+          BRANCH_NAME="${{ github.ref_name }}"
+          if [[ "$BRANCH_NAME" == "dev" ]]; then
+            IMAGE_TAG="dev"
+          elif [[ "$BRANCH_NAME" == "stable" ]]; then
+            # Checkout GitHub Action and set up QEMU and Docker Buildx
+            actions/checkout@v2
+            uses: docker/setup-qemu-action@v3
+            uses: docker/setup-buildx-action@v3
+            # Bump version and push tag
+            uses: anothrNick/[email protected]
+            id: setversion
+            env:
+              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+              WITH_V: true
+            IMAGE_TAG=${{ steps.setversion.outputs.new_tag }}
+          else
+            IMAGE_TAG=$BRANCH_NAME
+          fi
+          # Convert IMAGE_TAG to lowercase
+          IMAGE_TAG=$(echo $IMAGE_TAG | tr '[:upper:]' '[:lower:]')
+          echo "IMAGE_TAG=$IMAGE_TAG" >> $GITHUB_ENV
+          
+          # Convert repository owner to lowercase
+          REPO_OWNER=$(echo ${{ github.repository_owner }} | tr '[:upper:]' '[:lower:]')
+          echo "REPO_OWNER=$REPO_OWNER" >> $GITHUB_ENV
+
+      - name: Build, Tag, and Push Docker Image
+        env:
+          IMAGE_NAME: ghcr.io/${{ env.REPO_OWNER }}/decluttarr
+          IMAGE_TAG: ${{ env.IMAGE_TAG }}
+        run: |
+          TAG_LATEST=""
+          if [[ "$BRANCH_NAME" == "stable" ]]; then
+            TAG_LATEST="-t $IMAGE_NAME:latest"
+          fi
+
+          docker buildx build \
+            --platform linux/amd64,linux/arm64 -f docker/Dockerfile . \
+            --progress plain \
+            -t $IMAGE_NAME:$IMAGE_TAG \
+            $TAG_LATEST \
+            --label com.decluttarr.version=$IMAGE_TAG \
+            --label com.decluttarr.commit=$SHORT_COMMIT_ID \
+            --build-arg IMAGE_TAG=$IMAGE_TAG \
+            --build-arg SHORT_COMMIT_ID=$SHORT_COMMIT_ID \
+            --push
+
+  docker-image-clean-up:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clean up Docker images
+        uses: dataaxiom/[email protected]
+        with:
+          exclude-tags: dev
+          delete-untagged: true
+          delete-ghost-images: true
+          delete-partial-images: true
+          token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/delete.yml

@@ -0,0 +1,33 @@
+# Removes Docker images belonging to feature branches when the feature branch is deleted
+name: Branch Delete
+on:
+  delete:
+    branches:
+      - '*' 
+
+jobs:
+  delete-branch-docker-image:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Log in to GitHub Container Registry
+        uses: docker/login-action@v1
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Get deleted branch name
+        id: get_branch_name
+        run: |
+          # Use jq to extract the branch name from the event payload
+          BRANCH=$(cat ${{ github.event_path }} | jq --raw-output '.ref' | sed 's/refs\/heads\///')
+          # Convert branch name to lowercase
+          BRANCH_NAME=$(echo "$BRANCH" | tr '[:upper:]' '[:lower:]')
+          echo "BRANCH_NAME=$BRANCH_NAME" >> $GITHUB_ENV
+
+      - name: Remove Docker image
+        uses: dataaxiom/[email protected]
+        with:
+          delete-tags: ${{ env.BRANCH_NAME }}
+          token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,6 +1,5 @@
 __pycache__/
 .pytest_cache/
-.vscode/
 config/config.conf
 ToDo 
 snip*.py

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: local
+    hooks:
+      - id: black
+        name: black
+        entry: venv/bin/black
+        language: system
+        types: [python]
+
+

.pytest.ini

@@ -1,5 +1,5 @@
 [pytest]
-log_cli = true
+# log_cli = true
 addopts = -q --tb=short -s
 log_cli_level = INFO
 log_cli_format = %(asctime)s - %(levelname)s - %(name)s - %(message)s

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+    "editor.formatOnSave": true,
+    "editor.defaultFormatter": "ms-python.black-formatter"
+}

CONTRIBUTING.md

@@ -54,8 +54,9 @@ To get started:
 5) Adjust the config/config.conf to your needs
 6) Adjust the code in the files as needed
 7) Run the script (`python3 main.py`)
-8) Push your changes to your own git repo
+8) Push your changes to your own git repo and use a descriptive name for the branch name (e.g. add-feature-to-xyz; bugfix-xyz)
 9) Test the dev-image it creates automatically
 10) Create the PR from your repo to ManiMatter/decluttarr (dev branch)
-
-
+11) Make sure all checks pass
+12) Squash your commits
+13) Test that the docker image works that was created when you pushed to your fork