9.6 KiB
📜 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
🎯 Planned Features
- 🌉 Bridge relay variant
- 📊 Additional monitoring integrations (Datadog, New Relic)
- 🔄 Automatic relay configuration updates
- 🧪 Enhanced integration testing suite
1.1.0 - 2025-11-08
✨ Added
- 🧩 Input sanitization helpers to ensure safe numeric evaluation in all status checks
- 🧱 Integrated integer guard function (
is_integer) to prevent bad-number shell errors - 🕒 Unified UTC timestamp formatting for consistent output across commands
🧰 Improvements
- 📜
view-logs: Compact single-line statistics (📊 Stats: total | errors | warnings) for cleaner display - 📊 The dashboard script now requires API token authentication for secure access and features a new notification UI for better visibility.
- 🔑 The fingerprint script has been overhauled for cleaner output, better input validation, and a more helpful guide.
- 🧰 General shell cleanup and quoting improvements for portability across BusyBox, Alpine, and Debian-based images
🐛 Fixed
- 🧹 Removed recurring
sh: 0: bad numberwarnings instatusoutput - 🧩 Fixed multi-line log stats formatting issue in
view-logs - 🔧 Corrected potential false negatives in
BOOTSTRAP_PERCENTextraction - 🧠 Resolved misinterpretation of empty variables during numeric comparisons
- 🥬 Configuration, health checks, and monitoring have been refined for better reliability and integration.
🔒 Security
- 🧩 Verified
set -esafety to prevent unintended script exits on minor grep/curl failures - 🐳 Docker Compose now includes enhanced security configurations and persistent volume support to prevent data loss.
- 📋 Cosmos templates have been updated with more secure and sensible default environment variables.
1.0.9 - 2025-11-07
🧠 Maintenance and polish release improving shell reliability, output consistency, and readability across status and log utilities. 🎨 Streamlined log viewer formatting, sanitized numeric parsing, and removed noisy shell error messages for cleaner execution.
✨ Added
- 🧩 Input sanitization helpers to ensure safe numeric evaluation in all status checks
- 🧱 Integrated integer guard function (
is_integer) to prevent bad-number shell errors - 🕒 Unified UTC timestamp formatting for consistent output across commands
🧰 Improvements
- 📜
view-logs: Compact single-line statistics (📊 Stats: total | errors | warnings) for cleaner display - 🧅
status: Sanitized bootstrap parsing and error-free numeric comparison - ⚙️ Hardened
set -ehandling with fallback defaults for missing values - 🧩 Refined whitespace and CRLF handling in log parsing for improved compatibility
- 🧰 General shell cleanup and quoting improvements for portability across BusyBox, Alpine, and Debian-based images
🐛 Fixed
- 🧹 Removed recurring
sh: 0: bad numberwarnings instatusoutput - 🧩 Fixed multi-line log stats formatting issue in
view-logs - 🔧 Corrected potential false negatives in
BOOTSTRAP_PERCENTextraction - 🧠 Resolved misinterpretation of empty variables during numeric comparisons
🔒 Security
- 🧩 Verified
set -esafety to prevent unintended script exits on minor grep/curl failures - 🛡️ Strengthened input filtering to prevent malformed log content injection into shell context
🧠 Developer Notes
- ✅ Both
statusandview-logsscripts tested under Alpine BusyBox and Debian Dash shells - 🧩 Scripts now fully pass shellcheck (
shfmt+ POSIX mode) validation - 💡 Compatible with Docker health checks and CI/CD validation hooks
🧱 Summary:
Tor Guard Relay v1.0.9 delivers a clean, error-free shell experience, better numeric safety, and a polished command-line output for monitoring and log viewing.
1.0.8 - 2025-11-07
🧠 Polish and refinement release focused on versioning automation, tag safety, and improved metadata accuracy. ⚙️ Streamlined validation logic, consistent changelog generation, and safer build workflows.
✨ Added
- 🧩 Auto-generated
Unreleasedcompare link in workflows for dynamic changelog updates - ⚙️ Added commit and tag automation helpers for PowerShell (version bump, tagging, release)
- 📦 Improved changelog consistency between main branch and GitHub Releases
- 🕒 Timezone logic refined for full
Asia/Tokyosynchronization across workflows
🧰 Improvements
- 🧱 Improved workflow dependency order to prevent tag-push race conditions
- 🔄 Cleaned up redundant trigger filters and unified workflow paths
- 🧩 Optimized
dependabot.ymlandrenovate.jsonto coordinate update frequency - ⚡ Enhanced readability and validation of Docker builds via better cache strategy
- 📜 Simplified changelog entry structure for maintainability
🐛 Fixed
- 🧩 Fixed missing newline warning in
.github/dependabot.yml - 🔧 Resolved edge cases where both validation and release workflows triggered simultaneously
- 🧹 Cleaned outdated references to removed workflows in comments and docs
- 🧱 Corrected version links and metadata for previous releases
🔒 Security
- 🛡️ Verified hardened build permissions for
trivy-actionuploads - 🧩 Ensured consistent use of
security-events: writefor all scan jobs - 🔐 Confirmed package pin integrity in Renovate configuration
🧠 Developer Notes
- ✅ Push main first, tag only after successful validation
- 🧩 Tag creation now automatically updates release notes
- 🪄 PowerShell automation script simplifies version bumping and tagging
- 🕒 All recurring jobs (Dependabot, Renovate, Weekly Build) aligned to
Asia/Tokyo
🧱 Summary:
Tor Guard Relay v1.0.8 improves workflow safety, version traceability, and automation clarity while tightening CI/CD control and metadata consistency.
1.0.7 - 2025-11-07
🧠 Stability and automation refinement release focused on smarter dependency management and workflow consistency. ⚙️ Enhanced multi-architecture build validation and coordinated dependency automation.
(See prior section for full 1.0.7 details.)
1.0.6 - 2025-11-06
🧠 Stability improvements, enhanced IPv6 diagnostics, and dashboard optimizations. 🐳 Migrated base image back to Alpine 3.22.2 for improved compatibility and reproducible builds.
1.0.5 - 2025-11-06
🐳 Downgrade base image from Alpine 3.22.2 to 3.21.5
1.0.4 - 2025-11-06
(Unchanged from prior release, retained for version history)
1.0.3 - 2025-11-06
(Unchanged from prior release, retained for version history)
1.0.2 - 2025-11-05
(Unchanged from prior release, retained for version history)
1.0.1 - 2025-11-05
(Unchanged from prior release, retained for version history)
[1.0.0] - 2025-11-01
(Unchanged from prior release, retained for version history)
📊 Release Information
-
🎉 First Release: v1.0.0 (November 1, 2025)
-
📦 Current Stable: v1.1.0 (November 8, 2025)
-
🔗 Latest Release: GitHub Releases
-
🐳 Docker Images:
🔖 Version Support
| Version | Status | Support Level |
|---|---|---|
| 1.1.0 | 🟢 🛡️ Active | Full support (current stable) |
| 1.0.9 | 🟡 🔧 Maintenance | Security + critical fixes only |
| 1.0.8 | 🟠 ⚠️ Legacy | Security patches only – upgrade recommended |
| 1.0.7 | 🔴 ❌ EOL | No support – upgrade immediately |
🔗 Release Links
🙏 Contributors
Thank you to all contributors who have helped make this project better! See CONTRIBUTORS.md for a complete list.
📝 Changelog Guidelines
This changelog follows these principles:
- ✅ Semantic Versioning (MAJOR.MINOR.PATCH)
- 📅 Chronological Order (newest first)
- 🎯 User-Focused: what changed, not how
- 🔗 Linked Releases: direct GitHub release links
- 🏷️ Categorized Changes: Added, Fixed, Security, etc.
- 📝 Keep a Changelog format compliance
📖 For upgrade instructions, see MIGRATION.md 🔒 For security-related changes, see SECURITY.md