From 84cea50206a2e8cb75f0002e4bc4fed89c7bca30 Mon Sep 17 00:00:00 2001 From: Stefan Thoss Date: Sat, 5 Nov 2022 16:06:42 -0700 Subject: [PATCH] Rename repo and default branch (#14) --- .github/workflows/codeql.yml | 4 ++-- .github/workflows/docker-publish.yml | 4 ++-- .github/workflows/linter.yml | 4 ++-- README.md | 6 +++--- docker-compose.yml | 6 +++--- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 582170e..18d6872 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -2,9 +2,9 @@ name: CodeQL on: push: - branches: [ master ] + branches: [ main ] pull_request: - branches: [ master ] + branches: [ main ] schedule: - cron: '5 4 * * 0' diff --git a/.github/workflows/docker-publish.yml b/.github/workflows/docker-publish.yml index dd38240..90311d5 100644 --- a/.github/workflows/docker-publish.yml +++ b/.github/workflows/docker-publish.yml @@ -2,10 +2,10 @@ name: Docker on: push: - branches: [ master ] + branches: [ main ] tags: [ 'v*.*.*' ] pull_request: - branches: [ master ] + branches: [ main ] schedule: - cron: '15 14 * * *' diff --git a/.github/workflows/linter.yml b/.github/workflows/linter.yml index 42de5be..153cf78 100644 --- a/.github/workflows/linter.yml +++ b/.github/workflows/linter.yml @@ -3,7 +3,7 @@ name: Lint Code Base on: push: pull_request: - branches: [ master ] + branches: [ main ] jobs: build: @@ -20,7 +20,7 @@ jobs: uses: github/super-linter/slim@v4 env: VALIDATE_ALL_CODEBASE: false - DEFAULT_BRANCH: master + DEFAULT_BRANCH: main GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} LINTER_RULES_PATH: / PYTHON_BLACK_CONFIG_FILE: pyproject.toml diff --git a/README.md b/README.md index d08ebc7..9360cf1 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Air Quality -> InfluxDB Bridge +# Air Quality Bridge This Flask-based server accepts particulate matter/temperature/humidity data from a [sensor.community sensor](https://sensor.community/en/sensors/airrohr) and writes it to a InfluxDB 2.0 server. It also calculates the Air Quality Index (AQI) with [hrbonz/python-aqi](https://github.com/hrbonz/python-aqi). @@ -34,12 +34,12 @@ If everything is configured correctly, executing `curl -X GET http://localhost:5 If you want to build the Docker image locally, execute: ```shell -docker build -t air-quality-influxdb-bridge:devel . +docker build -t air-quality-bridge:devel . ``` ## Deployment -The Docker image from the repository gets automatically build and published to the GitHub Container Registry as [ghcr.io/stefanthoss/air-quality-influxdb-bridge](https://github.com/stefanthoss/air-quality-influxdb-bridge/pkgs/container/air-quality-influxdb-bridge). +The Docker image from the repository gets automatically build and published to the GitHub Container Registry as [ghcr.io/stefanthoss/air-quality-bridge](https://github.com/stefanthoss/air-quality-bridge/pkgs/container/air-quality-bridge). The best way to deploy the application is with Docker Compose. Download the `docker-compose.yml` file, change the environment variables according to your local setup, and start the Docker service with `docker-compose up`: diff --git a/docker-compose.yml b/docker-compose.yml index cdd7b70..f8dd428 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,9 +1,9 @@ version: "3" services: - air-quality-influxdb-bridge: - image: ghcr.io/stefanthoss/air-quality-influxdb-bridge:latest - container_name: air-quality-influxdb-bridge + air-quality-bridge: + image: ghcr.io/stefanthoss/air-quality-bridge:latest + container_name: air-quality-bridge restart: unless-stopped ports: - "5000:5000"