Merge pull request #2 from panubo/renovation

Renovation

Author: macropin

.dockerignore

@@ -1,3 +1,7 @@
+.dockerignore
 .git
+.github
+.gitignore
 Dockerfile
+LICENSE
 README.md

.github/workflows/build-push.yml

@@ -1,4 +1,6 @@
-# Panubo build and push to Quay.io and ECR Public
+# Source: https://github.com/panubo/reference-github-actions/blob/main/docker-images/build-push.yml
+#
+# Description: Panubo build and push to Quay.io and ECR Public
 # This GH Action is intended for public docker images that package upstream applications/services (ie not for projects of Panubo's).
 # For repos that build multiple repos use the multi-build-push.yml workflow.
 #
@@ -9,6 +11,8 @@
 # Automated testing is triggered by `make _ci_test`, if no test is required the Makefile target should just run `true`.
 # Before tests are run a Docker build is performed, the resulting image has a tag of "test"
 # BATS is installed since it is commonly required by the tests.
+#
+# LICENSE: MIT License, Copyright (c) 2021-2025 Volt Grid Pty Ltd t/a Panubo
 
 name: build and push on main and tags
 
@@ -33,7 +37,9 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v5
+        with:
+          submodules: true
 
       - name: Get repo name
         id: image_name
@@ -42,7 +48,7 @@ jobs:
 
       - name: Docker meta
         id: meta
-        uses: docker/metadata-action@v4
+        uses: docker/metadata-action@v5
         with:
           # list of Docker images to use as base name for tags
           images: |
@@ -59,28 +65,28 @@ jobs:
             # type=sha
 
       - name: Set up QEMU
-        uses: docker/setup-qemu-action@v2
+        uses: docker/setup-qemu-action@v3
 
       - name: Set up Docker Buildx
         id: buildx
-        uses: docker/setup-buildx-action@v2
+        uses: docker/setup-buildx-action@v3
 
       # The values provided to these two AWS steps are always the same for Panubo owned repos
       - name: Configure AWS Credentials
-        uses: aws-actions/configure-aws-credentials@v1-node16
+        uses: aws-actions/configure-aws-credentials@v4
         with:
           role-to-assume: ${{ env.GITHUB_ROLE_ARN }}
           aws-region: us-east-1
 
       - name: Login to ECR
         if: github.event_name != 'pull_request'
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: public.ecr.aws
 
       - name: Login to Quay.io
         if: github.event_name != 'pull_request'
-        uses: docker/login-action@v2
+        uses: docker/login-action@v3
         with:
           registry: quay.io
           username: ${{ secrets.PANUBUILD_QUAYIO_USERNAME }}
@@ -92,7 +98,7 @@ jobs:
           bats-version: 1.7.0
 
       - name: Build and export to Docker
-        uses: docker/build-push-action@v4
+        uses: docker/build-push-action@v6
         with:
           builder: ${{ steps.buildx.outputs.name }}
           cache-from: type=gha
@@ -104,7 +110,7 @@ jobs:
           make _ci_test
 
       - name: Build and Push
-        uses: docker/build-push-action@v3
+        uses: docker/build-push-action@v6
         with:
           builder: ${{ steps.buildx.outputs.name }}
           push: ${{ github.event_name != 'pull_request' }}

.github/workflows/github-release.yml

@@ -0,0 +1,46 @@
+# Source: https://github.com/panubo/reference-github-actions/blob/main/github-release.yml
+# Description: Create a GitHub release
+# LICENSE: MIT License, Copyright (c) 2021-2025 Volt Grid Pty Ltd t/a Panubo
+
+name: GitHub Release
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_call:
+
+permissions:
+  contents: write
+
+jobs:
+  build:
+    name: Create GitHub Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v5
+        with:
+          fetch-depth: 0 # Required for git log to work
+
+      - name: Get Release Notes
+        id: get_release_notes
+        run: |
+          NOTES=$(git log --pretty=format:%s $(git tag --sort=-v:refname | head -1)...$(git tag --sort=-v:refname | head -2 | tail -1) | awk '{ print "-", $0  }')
+          printf "notes<<EOF\\n%s\\nEOF\\n" "${NOTES}" >> "$GITHUB_OUTPUT"
+
+      - name: Create Release
+        id: create_release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # This token is provided by Actions, you do not need to create your own token
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: ${{ github.ref }}
+          body: |
+            Changes since last release:
+
+            ${{ steps.get_release_notes.outputs.notes }}
+
+          draft: false
+          prerelease: false

Dockerfile

@@ -1,4 +1,4 @@
-FROM alpine:3.19
+FROM alpine:3.23
 
 RUN set -x \
   && apk --no-cache add bash curl libc6-compat logrotate ssmtp \

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2016-2023 Volt Grid Pty Ltd
+Copyright (c) 2016-2024,2026 Volt Grid Pty Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,41 +1,100 @@
 # Docker Cron
 
-Cron in a container.
+[![build and push on main and tags](https://github.com/panubo/docker-cron/actions/workflows/build-push.yml/badge.svg)](https://github.com/panubo/docker-cron/actions/workflows/build-push.yml)
 
-This image is available on quay.io `quay.io/panubo/cron` and AWS ECR Public `public.ecr.aws/panubo/cron`.
+Cron in a container, based on Alpine Linux and [go-crond](https://github.com/webdevops/go-crond).
 
-## Configuration
+This image is publicly available from:
+- **Quay.io:** `quay.io/panubo/cron`
+- **AWS ECR Public:** `public.ecr.aws/panubo/cron`
+
+## Features
+
+- **Unprivileged Cron:** Cron jobs run as a non-root `cron` user.
+- **Lightweight:** Based on Alpine Linux.
+- **Flexible Logging:** `go-crond` logs to stdout/stderr, making it easy to integrate with container logging systems.
+- **Mail Support:** Send cron output via email using `ssmtp`.
+- **Dynamic Reloading:** Crontabs can be reloaded without restarting the container.
+
+## Usage
+
+### Basic Example
+
+To run a simple cron job, you need to mount a crontab file at `/crontab`.
 
-Mount the crontab at `/crontab`. The cron jobs will be run with the underprivileged `cron` user.
+`crontab` file:
+```crontab
+# Run every minute
+* * * * * echo "Hello from cron!"
+```
 
-N.B. The container will need to be restarted if the crontab is changed or exec `/reload.sh`.
+Run the container:
+```sh
+docker run --rm \
+  -v $(pwd)/crontab:/crontab \
+  quay.io/panubo/cron
+```
 
-Configure timezone with `TZ` environment variable. eg: `-e TZ=Australia/Sydney`
-or use `CRON_TZ` for each crontab line.
+### Docker Compose Example
 
-For linking to SMTP container (optional):
+For a more persistent setup, use `docker-compose`:
 
-- `SMTP_HOST`
-- `SMTP_PORT`
-- `SMTP_USER`
-- `SMTP_PASS`
+```yaml
+services:
+  cron:
+    image: quay.io/panubo/cron
+    container_name: my-cron-service
+    restart: unless-stopped
+    volumes:
+      - ./crontab:/crontab
+    environment:
+      - TZ=Australia/Sydney
+      - EMAIL_TO=your-email@example.com
+      # SMTP settings if you want email notifications
+      # - SMTP_HOST=smtp.example.com
+      # - SMTP_PORT=587
+      # - SMTP_USER=user
+      # - SMTP_PASS=password
+      # - EMAIL_FROM=cron@example.com
+```
+
+### Reloading Crontab
+
+If you update the `/crontab` file, you can reload it without restarting the container by executing the `/reload.sh` script:
+
+```sh
+docker exec my-cron-service /reload.sh
+```
+
+## Configuration
 
-Cron Email settings (optional):
+Configuration is managed through environment variables.
 
- - `EMAIL_FROM`
- - `EMAIL_TO`
- - `HOSTNAME`
+| Variable      | Description                                                                        | Default         |
+|---------------|------------------------------------------------------------------------------------|-----------------|
+| `TZ`          | Sets the container's timezone (e.g., `Australia/Sydney`).                          | `UTC`           |
+| `CRON_TZ`     | Sets the timezone for individual cron jobs in the crontab file.                    | -               |
+| `EMAIL_FROM`  | The `From:` address for cron emails.                                               | `cron`          |
+| `EMAIL_TO`    | The `To:` address for cron emails.                                                 | `cron`          |
+| `SMTP_HOST`   | The SMTP server host.                                                              | `localhost`     |
+| `SMTP_PORT`   | The SMTP server port.                                                              | `25`            |
+| `SMTP_USER`   | Username for SMTP authentication.                                                  | `''`            |
+| `SMTP_PASS`   | Password for SMTP authentication.                                                  | `''`            |
+| `HOSTNAME`    | Hostname to use for email headers.                                                 | container host  |
+| `DEBUG`       | Set to `true` to enable verbose script execution (`set -x`).                       | `false`         |
 
-## Example
+## Building from Source
 
-Example with timezone set:
+To build the image locally, you can use the provided `Makefile`:
 
-`docker run --rm -t -i -v $(pwd)/crontab:/crontab -e TZ=Australia/Sydney quay.io/panubo/cron:2.0.0`
+```sh
+make build
+```
 
 ## History
 
-- v1.x - Debian based
-- v2.x - Alpine Linux with [go-crond](https://github.com/webdevops/go-crond/), also includes additional tooling eg logrotate.
+- **v1.x:** Debian-based, using standard `vixie-cron`.
+- **v2.x:** Migrated to Alpine Linux with [go-crond](https://github.com/webdevops/go-crond) for better container integration. Also includes additional tooling like `logrotate` and `ssmtp`.
 
 ## Status
 

entry.sh

@@ -7,13 +7,13 @@ set -e
 echo ">> Running entry.sh"
 
 # Defaults
-: ${HOSTNAME:=$(hostname)}
-: ${EMAIL_FROM:='cron'}
-: ${EMAIL_TO:='cron'}
-: ${SMTP_HOST:='localhost'}
-: ${SMTP_PORT:='25'}
-: ${SMTP_USER:=''}
-: ${SMTP_PASS:=''}
+: "${HOSTNAME:=$(hostname)}"
+: "${EMAIL_FROM:='cron'}"
+: "${EMAIL_TO:='cron'}"
+: "${SMTP_HOST:='localhost'}"
+: "${SMTP_PORT:='25'}"
+: "${SMTP_USER:=''}"
+: "${SMTP_PASS:=''}"
 
 # Config checks
 [ ! -f "/crontab" ] && echo "Error: crontab must be mounted at /crontab" && exit 128 || true