Github CI

Author: pilotak

.github/workflows/dockerimage.yml

@@ -0,0 +1,69 @@
+name: docker build
+
+on:
+  push:
+    paths-ignore:
+      - "README.md"
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+  release:
+    types:
+      - created
+  schedule:
+    - cron: "0 0 1 * *"
+
+jobs:
+  build:
+    if: "!contains(github.event.commits[0].message, '[skip ci]')"
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+
+      - name: Prepare
+        id: prepare
+        run: |
+          HEAD_TAG=$(git tag --points-at HEAD)
+          PLATFORMS=linux/arm/v6,linux/arm/v7,linux/arm64
+          VERSION=latest
+
+          if [[ $HEAD_TAG =~ ^v[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}$ ]]; then
+            VERSION=${HEAD_TAG//v}
+          fi
+
+          echo ::set-output name=version::${VERSION}
+          echo ::set-output name=docker_image::${GITHUB_REPOSITORY//docker-}
+          echo ::set-output name=platforms::${PLATFORMS}
+
+      - name: Build on pull request
+        if: success() && github.event_name == 'pull_request'
+        run: |
+          docker build .
+
+      - name: Set up Docker Buildx
+        if: success() && github.event_name != 'pull_request'
+        uses: crazy-max/ghaction-docker-buildx@v3
+        with:
+          buildx-version: latest
+          qemu-version: latest
+
+      - name: Docker Login
+        if: success() && github.event_name != 'pull_request'
+        env:
+          DOCKER_USERNAME: ${{ secrets.DOCKER_USERNAME }}
+          DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
+        run: |
+          echo "${DOCKER_PASSWORD}" | docker login --username "${DOCKER_USERNAME}" --password-stdin
+
+      - name: Build & Push
+        if: success() && github.event_name != 'pull_request'
+        run: |
+          docker buildx build \
+            --platform ${{ steps.prepare.outputs.platforms }} \
+            --tag ${{ steps.prepare.outputs.docker_image }}:${{ steps.prepare.outputs.version }} \
+            --file ./Dockerfile \
+            --push .
+      

README.md

@@ -1,5 +1,5 @@
 # Raspberry Pi variable speed cooling fan controller
-
+![Docker Build](https://github.com/pilotak/docker-rpi-fan/workflows/docker%20build/badge.svg) ![Docker Pulls](https://img.shields.io/docker/pulls/pilotak/rpi-fan) ![Docker Size](https://img.shields.io/docker/image-size/pilotak/rpi-fan?color=orange)
 Docker container that keeps the CPU temperature at desired level with PWM enabled fan based on [http://www.sensorsiot.org/variable-speed-cooling-fan-for-raspberry-pi-using-pwm-video138/](http://www.sensorsiot.org/variable-speed-cooling-fan-for-raspberry-pi-using-pwm-video138/)
 
 ## Docker-compose
@@ -25,15 +25,15 @@ services:
 ### Environmental variables
 Bellow are all available variables
 
-| Variable | Description | Default value |
+| Variable | Description | Default value | Units |
 | --- | --- | :---:|
-| `DESIRED_TEMP` | Temperature it tries to keep it at *(°C)* | 40 |
-| `FAN_PIN` | PWM pin where is mosfet driver or load-switch connected to | 13 |
-| `FAN_PWM_MIN` | Minimal duty cycle to turn the fan on *(%)* | 20 | 
-| `FAN_PWM_MAX` | Maximal duty cycle of fan *(%)* | 100 | 
-| `FAN_PWM_FREQ` | Broker address *(Hz)* | 17 | 
-| `P_TEMP` | Proportional constant | 18.0 | 
-| `I_TEMP` | Integral constant | 0.3 | 
-| `READ_INTERVAL` | How often read the temperature *(seconds)* | 2 | 
+| `DESIRED_TEMP` | Temperature it tries to keep it at | 40 | °C |
+| `FAN_PIN` | PWM pin where is mosfet driver or load-switch connected to | 13 | |
+| `FAN_PWM_MIN` | Minimal duty cycle to turn the fan on | 20 | % |
+| `FAN_PWM_MAX` | Maximal duty cycle of fan | 100 | % |
+| `FAN_PWM_FREQ` | Broker address | 17 | Hz |
+| `P_TEMP` | Proportional constant | 18.0 |  |
+| `I_TEMP` | Integral constant | 0.3 |  |
+| `READ_INTERVAL` | How often read the temperature | 2 | seconds |