Skip to content

CHANGELOG.md

Latest commit

 

History

History
50 lines (34 loc) · 1.94 KB

CHANGELOG.md

File metadata and controls

50 lines (34 loc) · 1.94 KB

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.

2.0.1 - 2026-04-05

Added

  • Conflict prevention: class_exists() guards prevent fatal errors when multiple plugins bundle this library.

2.0.0 - 2026-04-05

Added

  • Composer package: Install via composer require soderlind/wordpress-github-updater.
  • Rate-limit mitigation:
    • Configurable check_period parameter (default: 6 hours).
    • Throttled checks when update already known (72 hours).
    • Optional auth_token parameter for GitHub authentication (increases rate limit from 60 to 5000 requests/hour).
  • API error logging: Logs GitHub API errors via puc_api_error hook when WP_DEBUG is enabled.
  • PSR-4 autoloading: Classes in src/ directory.

Changed

  • BREAKING: Package structure changed from single file to PSR-4 layout (src/GitHubUpdater.php, src/GitHub_Plugin_Updater.php).
  • GitHubUpdater::init() signature extended with two new optional parameters: check_period and auth_token.
  • Workflow templates moved to .github/workflows/.
  • Default check interval reduced from 12 hours to 6 hours.

Deprecated

  • GitHub_Plugin_Updater class — use GitHubUpdater::init() directly.

1.0.0 - 2024-03-01

Added

  • Initial release.
  • GitHubUpdater::init() static API.
  • GitHub_Plugin_Updater wrapper class with config array constructor.
  • Release asset filtering via name_regex.
  • Branch selection support.
  • GitHub Actions workflow templates for release builds.