Skip to main content

Changelog

DEVELOPER Beginner

Version history and changes for EZ-Console.

Overview​

This document tracks all notable changes to the EZ-Console framework. It follows Semantic Versioning principles.

Version History​

[Unreleased]​

Added​

  • New features and improvements in development

Changed​

  • Changes in development

Fixed​

  • Bug fixes in development

[1.0.0] - 2024-XX-XX​

Added​

  • Initial release of EZ-Console framework
  • Backend framework with Go + Gin
  • Frontend framework with React + TypeScript + Ant Design
  • JWT-based authentication
  • Role-Based Access Control (RBAC)
  • User management system
  • Audit logging
  • File upload/download support
  • OAuth2/OIDC integration
  • LDAP/Active Directory integration
  • Multi-Factor Authentication (MFA)
  • Internationalization (i18n) support
  • API documentation with Swagger
  • CLI command interface
  • Configuration management
  • Database migrations
  • Middleware system
  • Service layer architecture
  • Plugin architecture
  • Hooks and events system
  • Multi-tenancy support
  • WebSocket support
  • AI model integration
  • Code generation tools

Features​

  • Backend: RESTful API framework built on Gin
  • Frontend: Modern React SPA with Ant Design components
  • Database: Support for SQLite, MySQL, and PostgreSQL
  • Security: JWT authentication, RBAC, MFA, audit logging
  • Developer Experience: Hot reload, type safety, API generation

Version Format​

Each version entry follows this format:

### [Version] - YYYY-MM-DD

#### Added
- New features

#### Changed
- Changes to existing features

#### Deprecated
- Features that will be removed

#### Removed
- Removed features

#### Fixed
- Bug fixes

#### Security
- Security fixes

Breaking Changes​

Breaking changes are marked with ⚠️ and include migration instructions:

Example Breaking Change​

#### Changed ⚠️
- **API Change**: `OldFunction()` is now `NewFunction()`
  - Migration: Update all calls to use `NewFunction()`
  - See [Migration Guide](./migration-guides.md) for details

Deprecation Policy​

  • Deprecated features are marked in the changelog
  • Deprecated features remain functional for at least one major version
  • Migration guides are provided for deprecated features
  • Removal is announced in advance

How to Read the Changelog​

  1. Check Latest Version: Start with the most recent version
  2. Review Breaking Changes: Look for ⚠️ markers
  3. Check Migration Guides: Follow migration instructions
  4. Review New Features: See what's new
  5. Check Bug Fixes: See what issues were resolved

Version Numbering​

EZ-Console follows Semantic Versioning:

  • MAJOR.MINOR.PATCH (e.g., 1.2.3)
  • MAJOR: Breaking changes
  • MINOR: New features (backward compatible)
  • PATCH: Bug fixes (backward compatible)

Release Schedule​

  • Major Releases: Significant changes, breaking changes
  • Minor Releases: New features, backward compatible
  • Patch Releases: Bug fixes, security patches

Getting Updates​

Check Current Version​

# Backend
./server --version

# Frontend
cd web && pnpm list ez-console

Update Framework​

# Backend
go get -u github.com/sven-victor/ez-console@latest
go mod tidy

# Frontend
cd web
pnpm update ez-console

Subscribe to Updates​

  • GitHub Releases: Watch the repository for release notifications
  • GitHub Discussions: Join discussions about new features
  • Documentation: Check documentation for latest features

Note: For the most up-to-date changelog, visit the GitHub Releases page.