Add CHANGELOG.md with project versioning history

This commit is contained in:
Alexander Minges 2025-07-10 15:19:55 +02:00
parent 2686d310a0
commit 104a7d57b2
Signed by: Athemis
SSH key fingerprint: SHA256:TUXshgulbwL+FRYvBNo54pCsI0auROsSEgSvueKbkZ4

109
CHANGELOG.md Normal file
View file

@ -0,0 +1,109 @@
# Changelog
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/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Fixed
- Remove redundant topic name extraction from tests
- Improve JATS list tag conversion with sequential processing to handle ordered and unordered lists more robustly
- Standardize package imports and configure explicit exports
## [v2.0.2] - 2025-07-10
### Added
- Documentation infrastructure with Sphinx and RTD theme
- Multiversion documentation support
- Demo animated webp image to README
- Documentation website link in README
### Changed
- Migrated to pyproject.toml for modern project configuration
- Moved demo image from assets to docs directory
- Updated documentation build process for multiversion support
- Improved documentation structure and content
### Fixed
- Updated AbstractProcessor to accept optional console parameter
- Removed unused datetime import and simplified super() call
### Security
- Configured Secret Detection in GitLab CI
## [v2.0.1] - 2025-07-08
### Added
- GitLab CI integration with test reporting
- Updated badges in README.md
### Changed
- Migrated from Forgejo to GitLab CI for continuous integration
## [v2.0.0] - 2025-07-07
### Changed
- **BREAKING CHANGE**: Generalized script by removing organizational metadata
- Updated version number in README
- Removed duplicate heading in README
### Fixed
- Fixed README formatting issues
## [v1.1] - 2025-07-04
### Added
- Support for ROR (Research Organization Registry) institution identifiers in affiliations
- Additional topic metadata fields for OpenAlex integration
- Comprehensive docstrings to classes and methods
- Code coverage configuration and expanded test suite
- Information on flag for using ROR identifiers for institutions in README
### Changed
- Updated testing documentation and improved test structure
### Fixed
- Fixed license field being wrapped in tuple due to trailing comma
- Fixed missing affiliation in Person class output
- Fixed affiliation field name in Person class
## [v1.0] - 2025-03-21
### Added
- Initial release of doi2dataset
- DOI validation and normalization
- Metadata retrieval from external APIs (OpenAlex and CrossRef)
- Standard Dataverse metadata generation including:
- Title, publication date, and alternative URL
- Author information with affiliations and ORCID identifiers
- Dataset contact information (corresponding authors)
- Abstract and description
- Keywords and subject classification
- Grant/funding information
- License information when available
- Optional upload functionality to Dataverse.org servers
- Progress tracking with Rich library
- Configuration management with YAML files
- Command-line interface
[Unreleased]: https://git.uni-due.de/cbm343e/doi2dataset/-/compare/v2.0.2...HEAD
[v2.0.2]: https://git.uni-due.de/cbm343e/doi2dataset/-/compare/v2.0.1...v2.0.2
[v2.0.1]: https://git.uni-due.de/cbm343e/doi2dataset/-/compare/v2.0...v2.0.1
[v2.0.0]: https://git.uni-due.de/cbm343e/doi2dataset/-/compare/v1.1...v2.0
[v1.1]: https://git.uni-due.de/cbm343e/doi2dataset/-/compare/v1.0...v1.1
[v1.0]: https://git.uni-due.de/cbm343e/doi2dataset/-/tags/v1.0