Skip to content

Commit 860fea4

Browse files
committed
Add changelog and update packaging metadata
Introduces a CHANGELOG.md file following the Keep a Changelog format. Updates setup.py to append the changelog to the long description for PyPI, bumps the version to 1.0.0, and adds a Changelog link to project URLs.
1 parent 16ad5df commit 860fea4

File tree

2 files changed

+39
-1
lines changed

2 files changed

+39
-1
lines changed

CHANGELOG.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
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+
7+
## [Unreleased]
8+
- Prepare improvements and documentation updates.
9+
10+
## [1.0.0] - 2025-10-22
11+
### Added
12+
- Project now includes changelog linked from packaging metadata.
13+
- Minor documentation updates.
14+
15+
### Fixed
16+
- Packaging metadata clarified in `setup.py`.
17+
18+
## [0.1.7] - 2024-06-01
19+
### Added
20+
- Initial public release notes placeholder.
21+
22+
23+
24+
## [Unreleased]: https://github.com/harmonize-tools/socio4health/compare/v1.0.0...HEAD
25+
## [1.0.0]: https://github.com/harmonize-tools/socio4health/compare/v0.1.7...v1.0.0
26+
## [0.1.7]: https://github.com/harmonize-tools/socio4health/releases/tag/v0.1.7

setup.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,17 @@
1616
with open(path.join(here, 'README.md'), encoding='utf-8') as f:
1717
long_description = f.read()
1818

19+
# Optionally append the changelog to the long description so PyPI shows it
20+
changelog_path = path.join(here, 'CHANGELOG.md')
21+
try:
22+
with open(changelog_path, encoding='utf-8') as f:
23+
changelog = f.read()
24+
# Separate README and changelog with a horizontal rule for readability
25+
long_description = long_description + "\n\n---\n\n" + changelog
26+
except FileNotFoundError:
27+
# If changelog is missing, continue without it
28+
changelog = None
29+
1930
# Arguments marked as "Required" below must be included for upload to PyPI.
2031
# Fields marked as "Optional" may be commented out.
2132

@@ -28,7 +39,7 @@
2839
# For a discussion on single-sourcing the version across setup.py and the
2940
# project code, see
3041
# https://packaging.python.org/en/latest/single_source_version.html
31-
version='0.1.7', # Required
42+
version='1.0.0', # Required
3243

3344
# This is a one-line description or tagline of what your project does. This
3445
# corresponds to the "Summary" metadata field:
@@ -203,5 +214,6 @@
203214
project_urls={ # Optional
204215
'Bug Reports': 'https://github.com/harmonize-tools/socio4health/issues',
205216
'Source': 'https://github.com/harmonize-tools/socio4health/',
217+
'Changelog': 'https://github.com/harmonize-tools/socio4health/blob/main/CHANGELOG.md',
206218
},
207219
)

0 commit comments

Comments
 (0)