Skip to content

Commit a0750b1

Browse files
vtemianclaude
andcommitted
docs: add comprehensive changelog and remove codecov badge
Added CHANGELOG.md following Keep a Changelog format to document version 0.2.0 changes and removed codecov badge from README. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <[email protected]>
1 parent 5e352a8 commit a0750b1

File tree

2 files changed

+55
-1
lines changed

2 files changed

+55
-1
lines changed

CHANGELOG.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.2.0] - 2025-07-02
9+
10+
### Added
11+
- Comprehensive changelog documentation
12+
- Modern CI/CD pipeline with GitHub Actions
13+
- Matrix testing across Python 3.10-3.12 and Django 4.2-5.1
14+
- Automated PyPI publishing on version tags
15+
- Security scanning with pip-audit
16+
- Code quality checks with Ruff (linting and formatting)
17+
- Package build validation in CI
18+
- Digital attestations for package security
19+
20+
### Changed
21+
- **BREAKING**: Minimum Python version increased to 3.10 (from 3.8)
22+
- **BREAKING**: Minimum Django version increased to 4.2 (from 3.2)
23+
- Modernized project structure with `pyproject.toml` and `uv` for dependency management
24+
- Migrated from Travis CI to GitHub Actions
25+
- Updated django-silk dependency from git+https://github.com/jazzband/django-silk.git to PyPI version (>=5.4.0)
26+
- Improved development workflow with better dependency resolution
27+
- Enhanced release process with automated version bumping
28+
29+
### Fixed
30+
- Resolved CI/CD pipeline failures due to dependency conflicts
31+
- Fixed PyPI upload restrictions by removing direct git dependencies
32+
- Corrected GitHub Actions artifact upload/download actions (v3 → v4)
33+
- Improved version generation for clean releases without dev suffixes
34+
- Enhanced compatibility with modern Django versions
35+
36+
### Removed
37+
- Support for Python 3.8 and 3.9
38+
- Support for Django 3.2, 4.0, and 4.1
39+
- Travis CI configuration
40+
- Direct git dependencies that caused PyPI upload failures
41+
42+
## [0.0.3] - Previous Release
43+
44+
### Features
45+
- Django middleware for Server-Timing header support
46+
- Thread-local storage for request isolation
47+
- Timing services and context managers
48+
- Django-silk integration for SQL query timing
49+
- Compatible with Django 3.2+ and Python 3.8+
50+
51+
---
52+
53+
**Note**: This changelog was introduced in version 0.2.0. Previous versions may not have detailed change documentation.
54+
55+
For more information about Server-Timing header support, see the [README](README.md).

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
# django-server-timing
22

33
[![CI](https://github.com/vtemian/django-server-timing/actions/workflows/ci.yml/badge.svg)](https://github.com/vtemian/django-server-timing/actions/workflows/ci.yml)
4-
[![codecov](https://codecov.io/gh/vtemian/django-server-timing/branch/master/graph/badge.svg)](https://codecov.io/gh/vtemian/django-server-timing)
54

65
Django middleware that exposed collected metrics into [HTTP Server Timing](https://www.w3.org/TR/server-timing/) header.
76

0 commit comments

Comments
 (0)