Skip to content

CHANGELOG.md

Latest commit

 

History

History
109 lines (89 loc) · 4.64 KB

CHANGELOG.md

File metadata and controls

109 lines (89 loc) · 4.64 KB
Raw

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

1.3.0 - 2026-02-02

Added

  • deploy action: Wait for ready feature
    • Wait for deployment to be reachable before continuing
    • New inputs: wait-for-ready, health-endpoint, wait-timeout, wait-interval
    • Polls deployment URL until HTTP 2xx/3xx or timeout
    • PR comment only appears after deployment is healthy (when combined with comment-on-pr)
  • deploy action: QR code in PR comment
    • New input: qr-code (default: false)
    • QR code for easy mobile testing of preview deployments
    • Generated locally using qrencode (no external API calls, privacy-friendly)
  • .editorconfig for consistent editor formatting
  • .github/dependabot.yml for automated GitHub Actions updates
  • .gitignore for local settings and Claude plans
  • .claude/ configuration for AI assistant (coding rules, skills, workflow)

Changed

  • .pre-commit-config.yaml: require minimum version 4.5.0
  • CONTRIBUTING.md: simplify setup with uv instead of pip
  • release.yml: verify CHANGELOG entry exists, rollback tag on failure
  • deploy and cleanup actions: github-token now defaults to github.token
    • No longer necessary to explicitly pass github-token: ${{ secrets.GITHUB_TOKEN }}
    • Only needed when using a custom PAT for cross-repository operations
  • Bump actions/checkout from v4 to v6

Internal

  • Added justfile for common development tasks
  • Added pre-commit.ci configuration (weekly autoupdates, skip duplicates with CI)

1.2.0 - 2026-01-22

Added

  • cleanup action: PR comment update feature
    • Update the deploy PR comment to show cleanup status when PR is closed
    • New inputs: update-pr-comment, comment-header
    • New output: pr-comment-updated

1.1.0 - 2026-01-22

Added

  • deploy action: PR commenting feature

    • Automatically post/update a comment on PRs with the deployment URL
    • New inputs: comment-on-pr, github-token, comment-header
    • Upsert behavior: updates existing comment instead of creating duplicates

  • cleanup action: PR comment delete feature

    • Delete the deploy PR comment when PR is closed (default: enabled)
    • New inputs: delete-pr-comment, comment-header
    • New output: pr-comment-deleted

  • CI/CD pipeline with ShellCheck, actionlint, and yamllint

  • Branch protection and governance files (CODEOWNERS, issue templates, PR template)

  • CONTRIBUTING.md with development guidelines

  • SECURITY.md with security policy

  • Pre-commit hooks configuration

Changed

  • deploy and cleanup actions: github-token now defaults to github.token
    • No longer necessary to explicitly pass github-token: ${{ secrets.GITHUB_TOKEN }}
    • Only needed when using a custom PAT for cross-repository operations

Removed

  • BREAKING cleanup action: update-pr-comment input (use delete-pr-comment instead)
  • BREAKING cleanup action: pr-comment-updated output (use pr-comment-deleted instead)

Internal

  • Added justfile for common development tasks
  • Added pre-commit.ci configuration (weekly autoupdates, skip duplicates with CI)

Fixed

  • ShellCheck warnings: properly quoted GITHUB_OUTPUT
  • Actionlint configuration to only lint workflow files

1.0.0 - 2026-01-22

Added

  • Initial release of ZAD Actions
  • deploy action: Deploy container images to ZAD Operations Manager
    • Support for cloning configuration from existing deployments
    • force-clone parameter to re-clone even if deployment exists
    • Input validation for security (alphanumeric, hyphens, underscores, dots only)
    • 60-second curl timeout to prevent hanging
  • cleanup action: Remove ZAD deployments and GitHub resources
    • Delete ZAD deployments via Operations Manager API
    • Delete GitHub deployments (mark inactive, then delete)
    • Delete GitHub environments (requires admin token)
    • Delete container images from GHCR
    • Best-effort cleanup (continues even if individual steps fail)
  • Comprehensive documentation with examples
  • EUPL-1.2 license

Security

  • Input validation before logging to prevent injection attacks
  • Secure handling of API keys via environment variables
  • Dangerous character detection for container inputs