Skip to content

Release v2.1.0

Choose a tag to compare

View all tags
@huypq02 huypq02 released this 12 Jan 18:37
v2.1.0
b92255f

Release Notes - Version 2.1.0

Release Date: January 13, 2026

🎉 What's New in v2.1.0

1. CI/CD Workflow with GitHub Actions

We've implemented automated Continuous Integration and Continuous Deployment workflows to improve code quality and streamline the deployment process.

CI Pipeline (.github/workflows/ci.yml)

  • Automated Linting: Code quality checks using black and flake8
  • Multi-Version Testing: Automatic testing across Python 3.9, 3.10, 3.11, 3.12, and 3.13
  • Code Coverage: Generates coverage reports to track test coverage
  • Docker Build: Automated Docker image builds and publishing to GitHub Container Registry (ghcr.io)
  • Triggers: Runs on push to main branch or releases/** branches

CD Pipeline (.github/workflows/cd.yml)

  • Automated Deployment: Deploys to Render production environment after successful CI
  • Production Tracking: Environment tracking with deployment URLs
  • Triggers: Runs after CI workflow completes successfully on main branch

Benefits:

  • Ensures code quality before merging
  • Prevents breaking changes from reaching production
  • Automatic deployment on successful builds
  • Multi-version Python compatibility verification

2. Basic Test Cases for import_data Function

Added initial unit tests for the import_data function to ensure reliable file handling.

Test Coverage (tests/test_text_stats.py)

  • ✅ Verifies function returns a string
  • ✅ Tests file reading functionality
  • ✅ Ensures proper UTF-8 encoding support

Benefits:

  • Validates core functionality
  • Prevents regressions
  • Foundation for expanded test coverage
  • Automated testing in CI pipeline

📚 Documentation Updates

  • Added comprehensive CI/CD Pipeline section to README.md
  • Documented testing procedures and commands
  • Added CI/CD requirements (GitHub secrets and variables)
  • Included badge status examples for repository visibility

🚀 How to Use

Run Tests Locally

# Run all tests
python -m unittest discover tests

# Run specific test
python -m unittest tests.test_text_stats

CI/CD Setup

See the CI/CD Pipeline section in README.md for complete setup instructions.

📦 Installation

No breaking changes. Simply pull the latest code:

git pull origin main
pip install -r requirements.txt

🔗 Links

👥 Contributors

Thank you to everyone who contributed to this release!

Previous Version: 2.0.0
Current Version: 2.1.0

Full Changelog: https://github.com/huypq02/word-frequency-mini-project/commits/releases/v2.1.0

Assets 2
Loading