Merge branch 'master' of https://github.com/healthchecks/healthchecks

Author: xtruan

.github/workflows/coverage.yml

@@ -10,18 +10,18 @@ jobs:
     test:
         runs-on: ubuntu-24.04
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v5
             - name: Set up Python
-              uses: actions/setup-python@v4
+              uses: actions/setup-python@v5
               with:
-                  python-version: "3.11"
+                  python-version: "3.12"
             - name: Install Dependencies
               run: |
                   sudo apt-get update -qq
                   sudo apt-get install -y libcurl4-openssl-dev libpython3-dev libssl-dev
                   python -m pip install --upgrade pip
-                  pip install -r requirements.txt
-                  pip install apprise braintree coverage coveralls minio
+                  pip install -r requirements.txt -r requirements-dev.txt
+                  pip install coverage coveralls
             - name: Run Tests
               env:
                   SECRET_KEY: dummy-key

.github/workflows/mypy.yml

@@ -14,15 +14,13 @@ jobs:
             - name: Set up Python
               uses: actions/setup-python@v4
               with:
-                  python-version: "3.11"
+                  python-version: "3.12"
             - name: Install Dependencies
               run: |
                   sudo apt-get update -qq
                   sudo apt-get install -y libcurl4-openssl-dev libpython3-dev libssl-dev
                   python -m pip install --upgrade pip
-                  pip install -r requirements.txt
-                  pip install apprise braintree minio
-                  pip install mypy==1.13.0 django-stubs types-braintree types-pycurl==7.45.2.20240311 types-Markdown types-pygments
+                  pip install -r requirements.txt -r requirements-dev.txt
                   touch hc/local_settings.py
             - name: Run Mypy
-              run: mypy --strict hc
+              run: mypy --strict --show-traceback hc

.github/workflows/publish_docker_image.yml

@@ -21,7 +21,7 @@ jobs:
 
             - name: Extract metadata (tags, labels) for Docker
               id: meta
-              uses: docker/metadata-action@v4
+              uses: docker/metadata-action@v5
               with:
                   images: healthchecks/healthchecks
 
@@ -42,3 +42,5 @@ jobs:
                   push: true
                   tags: ${{ steps.meta.outputs.tags }}
                   labels: ${{ steps.meta.outputs.labels }}
+                  annotations: ${{ steps.meta.outputs.annotations }}
+                  sbom: true

.github/workflows/tests.yml

@@ -12,7 +12,7 @@ jobs:
         strategy:
             matrix:
                 db: [sqlite, postgres, mysql, mariadb]
-                python-version: ["3.10", "3.11", "3.12"]
+                python-version: ["3.12", "3.13", "3.14"]
                 include:
                     - db: postgres
                       db_user: runner
@@ -25,11 +25,12 @@ jobs:
                       db_password: ""
 
         steps:
-            - uses: actions/checkout@v3
+            - uses: actions/checkout@v5
             - name: Set up Python ${{ matrix.python-version }}
-              uses: actions/setup-python@v4
+              uses: actions/setup-python@v5
               with:
                   python-version: ${{ matrix.python-version }}
+                  allow-prereleases: true
             - name: Start MySQL
               if: matrix.db == 'mysql'
               run: sudo systemctl start mysql.service
@@ -46,8 +47,7 @@ jobs:
                   sudo apt-get update -qq
                   sudo apt-get install -y libcurl4-openssl-dev libpython3-dev libssl-dev
                   python -m pip install --upgrade pip
-                  pip install -r requirements.txt
-                  pip install apprise minio mysqlclient
+                  pip install -r requirements.txt -r requirements-dev.txt
             - name: Run Tests
               env:
                   DB: ${{ matrix.db }}

CHANGELOG.md

@@ -1,7 +1,83 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
-## v3.10-dev - Unreleased
+## v4.1-dev - Unreleased
+
+### Improvements
+- Remove team size limits: users on all plans can now invite many team members
+
+### Bug Fixes
+- Fix a formatting issue in Matrix notification template (#1264, @neoscaler)
+
+## v4.0 - 2026-01-22
+
+This release drops support of Python 3.11 and below. The minimum required Python
+version is 3.12.
+
+### Improvements
+- Upgrade to Django 6.0
+- Update the Matrix integration to use Matrix v3 API (#1244)
+- Update email alert template to use user's preferred time zone (#1230)
+- Update the web UI to use user's preferred timezone instead of browser's timezone
+- Add data migration to update legacy timezones to current canonical timezones (#1250)
+- Switch to using multicolor icon font for integration icons
+
+### Bug Fixes
+- Fix the text version of email report for recently created checks (#1236, @adelton)
+- Fix prepare_durations() to assert ping ordering by id not by created date
+- Fix the "Pause" API call and UI action to no-op if the check is already paused
+
+## v3.13 - 2025-11-30
+
+### Improvements
+- Add new content filtering options in the "Filtering Rules" dialog (#1130, #954)
+- Fix the email integration's unsub view to disable (not delete) the channel
+- Add support for _FILE environment variables (#1184)
+
+### Bug Fixes
+- Pin minio in Dockerfile to a known good version (#1235)
+
+## v3.12 - 2025-11-26
+
+### Improvements
+- Add rate limiting and a default ntfy.sh token support for ntfy notifications
+- Sort checks in daily/weekly/monthly reports by downtime duration, then by name (#1095)
+- Generate lower-case ping keys to work around broken email providers (#1218)
+- After creating a ping key show a dialog displaying the new ping key (#1222)
+- Add a tooltip with timestamp in the checks table, "Last Ping" column (#1040)
+- Update the Zulip transport to allow addressing users by User ID (#771)
+- Add hc_check_grace and hc_check_paused Prometheus metrics (#897, #915)
+- Update Docker base image to python:3.13.9-slim-trixie (#1233)
+
+### Bug Fixes
+- Fix cron schedule formatting in Discord notifications
+- Fix cron schedule formatting in Rocket.Chat notifications (in mobile app)
+
+## v3.11.2 - 2025-09-02
+
+### Bug Fixes
+- Update Docker image to handle legacy time zones (#1210)
+
+## v3.11.1 - 2025-08-31
+
+### Improvements
+- Update Dockerfile to use Debian Trixie as the base
+
+### Bug Fixes
+- Update Docker image to listen on IPv6 only if LISTEN_IPV6 env var is set (#1207)
+
+## v3.11 - 2025-08-28
+
+### Improvements
+- Store project API keys in the database in a hashed form (#1167)
+- Use "hcw_" and "hcr_" prefixes in project API keys (#1148)
+- New integration: Google Chat (#423)
+- Fix the ping view to handle IPv4-mapped IPv6 addresses (#1169)
+- Update Dockerfile to listen on IPv6 as well (#1177)
+- Add "ping_key+slug@..." address support when pinging by email (#1009)
+- Add daily email report option (#1202)
+
+## v3.10 - 2025-05-09
 
 ### Improvements
 - Add "badge_url" field in Check API responses (#1100)
@@ -12,6 +88,7 @@ All notable changes to this project will be documented in this file.
 - Update "?rid=<uuid>" handling to allow UUIDs with uppercase letters (#1116, @wie-niet)
 - New integration: GitHub issues (#671)
 - Add support for passing Authorization header to Prometheus metrics endpoints
+- Upgrade to Django 5.2
 
 ### Bug Fixes
 - Fix incorrect status value in Webhook integration's $JSON placeholder

CONTRIBUTING.md

@@ -2,24 +2,31 @@
 
 I'm open to feature suggestions and happy to review code contributions.
 If you are planning to contribute something larger than a small, straightforward
-bugfix, please open an issue so we can discuss it first. Otherwise you are risking a 
+bugfix, please open an issue so we can discuss it first. Otherwise you are risking a
 "no" or a "yes, but let's do it differently" to an already implemented feature.
 
+## AI Policy
+
+I do not accept content generated or touched up by AI tools. Do not
+submit pull requests or issues produced with the help of LLMs or code generation
+assistants, they will be closed with no discussion. Do not write emails
+generated or rewritten by LLMs, they will be marked as spam.
+
 ## Code Style
 
-* Format your Python code with [black](https://black.readthedocs.io/en/stable/).
+* Format your Python code with [ruff](https://docs.astral.sh/ruff/).
 * Prefer simplicity over cleverness.
-* If you are fixing a bug or adding a feature, add a test. Run tests before 
+* If you are fixing a bug or adding a feature, add a test. Run tests before
   submitting pull requests.
 
 ## Adding Documentation
 
-This project uses the Markdown format for documentation. Use the `render_docs` 
+This project uses the Markdown format for documentation. Use the `render_docs`
 management command to generate the HTML version of the documentation. To add a new
 documentation page:
 
 1. Create the appropriate .md file under `templates/docs`
-2. Generate the HTML version with `./manage.py render_docs` 
+2. Generate the HTML version with `./manage.py render_docs`
 3. Add the page to the navigation in `/templates/front/docs_single.html`
 
 ## Developing a New Integration
@@ -41,20 +48,23 @@ The best way to build a new integration is to pick a similar existing integratio
 as a starting point for the new integration and replicate every aspect of it.
 You will need to make changes in the following files:
 
-* Add a new class in `/hc/api/transports.py`.
-* Add a new notification template in `/templates/integrations/`.
-* Write testcases for the new transport class in `/hc/api/tests/test_notify_<kind>.py`.
-* Update `CHANNEL_KINDS` in `/hc/api/models.py`.
-* Update `Channel.transport()` in `/hc/api/models.py`.
-* Create a view for provisioning the new integration in `/hc/front/views.py`.
-* Write a HTML template for the new view in `/templates/front/add_<kind>.py`, and
-  prepare any supporting illustrations in `/static/img/integrations/`.
-* Add a route for the new view in `/hc/front/urls.py`.
-* Write testcases for the new view in `/hc/font/tests/test_add_<kind>.py`.
+* In `/hc/integrations/`, copy an existing integration to a new directory
+* Edit the transport class in `/hc/integrations/<kind>/transport.py`.
+* Edit the notification template(s) in `/hc/integrations/<kind>/templates/`.
+* Write testcases for the transport class in
+  `/hc/integrations/<kind>/tests/test_notify.py`.
+* Update `TRANSPORTS` in `/hc/api/models.py`.
+* Edit the view(s) for provisioning the integration in
+  `/hc/integrations/<kind>/views.py`.
+* Write a HTML template for the new view in
+  `/hc/integrations/<kind>/templates/</add_<kind>.py`, and prepare any supporting
+  illustrations in `/hc/integrations/<kind>/static/img/`.
+* Edit routes for the new view(s) in `/hc/integrations/<kind>/urls.py`.
+* Include the new integration's urls.py in `/hc/urls.py`
+* Write testcases for the new view in `/hc/integrations/<kind>/tests/test_add.py`.
 * Update `/templates/front/channels.html` – add a new section in the list of available
   integrations, make sure an existing integration is displayed nicely.
 * Update `/templates/front/event_summary.html` to make sure notifications sent to the
   new integration are displayed nicely.
-* Add a logo in `/static/img/integrations/`.
+* Add a logo in `/hc/integrations/<kind>static/img/`.
 * Update the icon font (it's a little tricky to do, I can take care of that).
-

README.md

@@ -13,8 +13,8 @@ team management features: projects, team members, read-only access.
 
 The building blocks are:
 
-* Python 3.10+
-* Django 5.1
+* Python 3.12+
+* Django 6.0
 * PostgreSQL, MySQL or MariaDB
 
 Healthchecks is licensed under the BSD 3-clause license.
@@ -57,6 +57,9 @@ You can use them in your READMEs, dashboards, or status pages.
 
 ## Setting Up for Development
 
+If you are planning to developing Healthchecks, please read
+[CONTRIBUTING.md](https://github.com/healthchecks/healthchecks/tree/master/CONTRIBUTING.md).
+
 To set up Healthchecks development environment:
 
 * Install dependencies (Debian/Ubuntu):
@@ -78,8 +81,8 @@ To set up Healthchecks development environment:
   (with virtualenv you get pip, we'll use it soon to install requirements):
 
   ```sh
-  python3 -m venv hc-venv
-  source hc-venv/bin/activate
+  python3 -m venv .venv
+  source .venv/bin/activate
   pip3 install wheel # make sure wheel is installed in the venv
   ```
 
@@ -92,7 +95,7 @@ To set up Healthchecks development environment:
 * Install requirements (Django, ...) into virtualenv:
 
   ```sh
-  pip install -r healthchecks/requirements.txt
+  pip install -r healthchecks/requirements.txt -r healthchecks/requirements-dev.txt
   ```
 
 * macOS only - pycurl needs to be reinstalled using the following method (assumes OpenSSL was installed using brew):
@@ -297,10 +300,6 @@ setting to a non-null value. Set its value to your site's domain without scheme
 and without port. For example, if your site runs on `https://my-hc.example.org`,
 set `RP_ID` to `my-hc.example.org`.
 
-Note that WebAuthn requires HTTPS, even if running on localhost. To test WebAuthn
-locally with a self-signed certificate, you can use the `runsslserver` command
-from the `django-sslserver` package.
-
 ## External Authentication
 
 Healthchecks supports external authentication by means of HTTP headers set by
@@ -548,7 +547,7 @@ in production.
     [ADMINS](https://docs.djangoproject.com/en/4.2/ref/settings/#admins) and
     [SERVER_EMAIL](https://docs.djangoproject.com/en/4.2/ref/settings/#server-email)
     settings. Consider setting up exception logging with [Sentry](https://sentry.io/for/django/).
-* Management commands that need to be run during each deployment.
+* Management commands that need to be run during each version upgrade.
   * `manage.py compress` – creates combined JS and CSS bundles and
      places them in the `static-collected` directory.
   * `manage.py collectstatic` – collects static files in the `static-collected`

docker/Dockerfile

@@ -1,35 +1,36 @@
-# syntax=docker/dockerfile:1
-
-FROM python:3.13.1-slim-bookworm AS builder
+FROM python:3.14.3-slim-trixie AS builder
 
 SHELL ["/bin/bash", "-o", "pipefail", "-c"]
 
 COPY requirements.txt /tmp
+# build-essential is required to build uswsi, psycopg, mysqlclient
+# libffi-dev is required to build cffi (a dependency of minio)
+# libpq-dev is required to build psycopg[c]
+# libmaria-dev is required to build mysqlclient
+# libcurl4-openssl-dev is required to build pycurl
+# pkg-config is required to build mysqlclient
 RUN \
     apt-get update && \
-    apt-get install -y build-essential curl libpq-dev libmariadb-dev libffi-dev libpcre2-dev libssl-dev libcurl4-openssl-dev libsasl2-dev libldap2-dev libpython3-dev pkg-config
-RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | bash -s -- --profile minimal -y
-ENV PATH=$PATH:/root/.cargo/bin
-RUN pip wheel --wheel-dir /wheels apprise uwsgi mysqlclient minio psycopg-c==3.2.3 -r /tmp/requirements.txt
+    apt-get install -y build-essential libffi-dev libpq-dev libmariadb-dev libcurl4-openssl-dev pkg-config libsasl2-dev libldap2-dev
+RUN pip wheel --wheel-dir /wheels apprise uwsgi mysqlclient minio==7.2.20 "psycopg[c]" -r /tmp/requirements.txt
 
 COPY . /opt/healthchecks/
 RUN \
     rm -rf /opt/healthchecks/.git && \
     rm -rf /opt/healthchecks/stuff
 
-FROM python:3.13.0-slim-bookworm
+FROM python:3.14.3-slim-trixie
 
 RUN useradd --system hc
 ENV PYTHONUNBUFFERED=1
 WORKDIR /opt/healthchecks
 
 RUN \
     apt-get update && \
-    apt-get install -y ca-certificates libcurl4 libexpat1 libpq5 libmariadb3 libxml2 && \
+    apt-get install -y libcurl4t64 libpq5 libmariadb3 ca-certificates && \
     rm -rf /var/apt/cache && \
     rm -rf /var/lib/apt/lists
 
-
 RUN --mount=type=bind,target=/wheels,source=/wheels,from=builder \
     pip install --upgrade pip && \
     pip install --no-cache /wheels/*