docs: simplify CHANGELOG for auto-generation by semantic-release
This commit is contained in:
parent
fbe5772302
commit
16814fcf3f
62
CHANGELOG.md
62
CHANGELOG.md
@ -5,13 +5,15 @@ All notable changes to this project will be documented in this file.
|
|||||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
|
||||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||||
|
|
||||||
|
**This changelog is automatically generated by [python-semantic-release](https://python-semantic-release.readthedocs.io/).**
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## [Unreleased]
|
## [Unreleased]
|
||||||
|
|
||||||
### Planned
|
See [commits](https://git.much-data.ru/much-data/kwork-api/compare/v0.1.0...main) since last release.
|
||||||
- Full CI/CD pipeline with Gitea Actions
|
|
||||||
- Automatic publishing to Gitea Package Registry
|
---
|
||||||
- Database support for caching (optional)
|
|
||||||
- Rate limiting utilities
|
|
||||||
|
|
||||||
## [0.1.0] - 2026-03-23
|
## [0.1.0] - 2026-03-23
|
||||||
|
|
||||||
@ -19,52 +21,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
|
|||||||
- Initial release
|
- Initial release
|
||||||
- Complete Kwork.ru API client with 45+ endpoints
|
- Complete Kwork.ru API client with 45+ endpoints
|
||||||
- Pydantic models for all API responses
|
- Pydantic models for all API responses
|
||||||
- Comprehensive error handling (7 exception types)
|
- Comprehensive error handling
|
||||||
- 100% docstring coverage (Russian language)
|
|
||||||
- MkDocs documentation with mkdocstrings
|
|
||||||
- Unit tests with 92% coverage
|
- Unit tests with 92% coverage
|
||||||
- UV package manager support
|
- CI/CD pipeline with Gitea Actions
|
||||||
- Gitea Actions CI/CD pipeline
|
|
||||||
|
|
||||||
### Models
|
---
|
||||||
- KworkUser, KworkCategory, Kwork, KworkDetails
|
|
||||||
- PaginationInfo, CatalogResponse
|
|
||||||
- Project, ProjectsResponse
|
|
||||||
- Review, ReviewsResponse
|
|
||||||
- Notification, NotificationsResponse, Dialog
|
|
||||||
- AuthResponse, ErrorDetail, APIErrorResponse
|
|
||||||
- City, Country, TimeZone, Feature, Badge
|
|
||||||
- DataResponse
|
|
||||||
|
|
||||||
### API Groups
|
*For older versions, see the Git history.*
|
||||||
- CatalogAPI — каталог кворков
|
|
||||||
- ProjectsAPI — биржа проектов
|
|
||||||
- UserAPI — пользовательские данные
|
|
||||||
- ReferenceAPI — справочные данные
|
|
||||||
- NotificationsAPI — уведомления
|
|
||||||
- OtherAPI — дополнительные эндпоинты
|
|
||||||
|
|
||||||
### Security
|
|
||||||
- Two-step authentication (cookies + web_auth_token)
|
|
||||||
- Session management
|
|
||||||
- Token-based authentication
|
|
||||||
|
|
||||||
### Documentation
|
|
||||||
- Full API reference (MkDocs + mkdocstrings)
|
|
||||||
- Usage examples in all docstrings
|
|
||||||
- RELEASE.md guide
|
|
||||||
- ARCHITECTURE.md
|
|
||||||
|
|
||||||
### Technical
|
|
||||||
- Python 3.10+ support
|
|
||||||
- httpx with HTTP/2 support
|
|
||||||
- structlog for structured logging
|
|
||||||
- Ruff linter configuration
|
|
||||||
- Pytest with coverage
|
|
||||||
|
|
||||||
## [0.0.1] - 2026-03-22
|
|
||||||
|
|
||||||
### Added
|
|
||||||
- Project initialization
|
|
||||||
- Basic project structure
|
|
||||||
- First API endpoints implementation
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user