This release introduces **CBR Custom - News Feeds** with the following key highlights:
Features
- **CI/CD Pipeline**: Fully integrated pipeline with GitHub Actions for:
- Running unit, integration, and QA tests with 100% code coverage.
- Automatic deployment to PyPI.
- Container image publishing to AWS Elastic Container Registry (ECR).
- Deployment of an AWS Lambda function.
- **Lambda Deployment**:
- New Lambda function deployed via `Deploy_Lambda__Cbr_Custom__News_Feeds.py` script.
- Updated Dockerfile for Lambda integration with ASGI (FastAPI) using Mangum.
CI/CD Enhancements
- **Pipeline Updates**:
- Separated unit, integration, and QA test stages for better visibility and coverage.
- Added a new GitHub Action to run QA tests (`aws__run-qa-tests`).
- Updated environment variable usage in workflows for streamlined AWS credential management.
- **Docker Enhancements**:
- Created a dedicated `Dockerfile` for `cbr_custom_news_feeds`.
- Introduced `docker-compose.yml` for local container testing.
- **Version Management**:
- Automated versioning updates with a `version` file tracked in the repository.
Testing
- **Comprehensive Test Coverage**:
- Unit tests organized under `tests/unit`.
- Integration tests organized under `tests/integration`.
- QA tests introduced under `tests/qa`.
Project Structure
- Refactored project structure:
- All files in `cbr_custom_news_feeds`.
- Modularized FastAPI application under `cbr_custom_news_feeds/fast_api`.
- Added routing for version information through `/info/version`.
Documentation
- Updated `README.md`:
- Updated project title and details to reflect the new project name and purpose.
FastAPI with Swagger support
<img width="886" alt="image" src="https://github.com/user-attachments/assets/75c927dc-9d68-478e-9309-80c4cdfbcc4e">
---
Installation and Usage
1. Install the package:
bash
pip install cbr_custom_news_feeds
2. Run the FastAPI server locally:
uvicorn cbr_custom_news_feeds.lambdas.handler:app --host 0.0.0.0 --port 8080
Acknowledgments
This milestone marks the first stable release with robust deployment automation, extensive testing, and a strong foundation for future development.
-----
(Prompt used in ChatGPT 4o)
Hi can you give me the release notes for for this version (this is going to be v1.0.0 which is the first release with a CI/DC pipeline, pypi deployment, ECR container publish, creation of AWS lambda function and comprehensive set of tests with 100% code coverage: test, integration and QA)
... copy and past of git diff from https://github.com/the-cyber-boardroom/cbr-custom--news-feeds/compare/v0.1.0...v1.0.0.diff ...