docs: add changelog with git-cliff configuration

This commit is contained in:
Antoine Anceau committed 2026-02-07 11:05:35 +01:00
1 parent f49cfc7b3f
commit 90a0d9faf4
2 files changed
+151

No files matched your search

+67
View File
@@ -0,0 +1,67 @@
# Changelog
All notable changes to NavalToolbox 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).
## [0.4.2] - 2026-02-07
### Fixed
- **hydrostatics**: Implement robust fallback solver with Coordinate Descent + Bisection for extreme equilibrium cases
- **hydrostatics**: Restore VCG parameter handling in equilibrium solvers
## [0.4.1] - 2026-02-06
### Fixed
- **hydrostatics**: Correct heel sign convention (TcG>0 → negative heel)
- **hydrostatics**: Compute equilibrium heel/trim from off-center COG
- **hydrostatics**: Preserve COG in `from_displacement` when VCG provided
### Documentation
- Add coordinate system conventions to userguide
- Fix Y axis convention in Tank docstrings
## [0.4.0] - 2026-02-04
### Added
- Complete hydrostatic properties: LOS (Length Overall Submerged), Wetted Surface Area
- Sectional area curve calculation
- Freeboard calculation with deck edges
- Appendages support for additional volume/center corrections
### Fixed
- Python and Rust lint errors
### Documentation
- Update visualization tutorial for Appendages and Deck Edges
- Add sectional_areas and freeboard to HydrostaticState documentation
## [0.3.0] - 2026-01-19
### Added
- GZ curve calculation with trim optimization
- Downflooding openings detection during stability calculations
- Silhouette wind heeling calculations (DXF/VTK support)
- Rhai scripting engine for custom stability criteria
### Changed
- Refactored hydrostatics fields to use public properties
## [0.2.0] - 2026-01-08
### Added
- Multi-hull support (catamarans, trimarans)
- Tank management with free surface corrections
- Complete stability analysis combining hydrostatics, GZ curve, and wind data
## [0.1.0] - 2026-01-01
### Added
- Initial release
- Hull geometry loading (STL/VTK files)
- Basic hydrostatics: Volume, COB, Waterplane properties
- Python bindings via PyO3/Maturin
---
*Generated with [git-cliff](https://git-cliff.org/) and manually curated*
+84
View File
@@ -0,0 +1,84 @@
# git-cliff configuration for NavalToolbox
# https://git-cliff.org/docs/configuration
[changelog]
# Changelog header
header = """
# Changelog
All notable changes to NavalToolbox 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).
"""
# Template for the changelog body
body = """
{% if version %}\
## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% else %}\
## [Unreleased]
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
### {{ group | striptags | trim | upper_first }}
{% for commit in commits %}
- {% if commit.scope %}**{{ commit.scope }}**: {% endif %}\
{{ commit.message | upper_first }}\
{% endfor %}
{% endfor %}
"""
# Remove leading and trailing whitespace
trim = true
# Changelog footer
footer = """
---
*Generated with [git-cliff](https://git-cliff.org/)*
"""
# Postprocessors
postprocessors = []
[git]
# Parse conventional commits
conventional_commits = true
# Include all commits, not just conventional ones
filter_unconventional = false
# Process commits in chronological order
split_commits = false
# Regex for commit parsing
commit_parsers = [
{ message = "^feat", group = "Added" },
{ message = "^fix", group = "Fixed" },
{ message = "^doc", group = "Documentation" },
{ message = "^perf", group = "Performance" },
{ message = "^refactor", group = "Changed" },
{ message = "^style", group = "Styling" },
{ message = "^test", group = "Testing" },
{ message = "^chore\\(release\\)", skip = true },
{ message = "^chore\\(deps.*\\)", skip = true },
{ message = "^chore\\(pr\\)", skip = true },
{ message = "^chore\\(pull\\)", skip = true },
{ message = "^chore|^ci", group = "Miscellaneous" },
{ body = ".*security", group = "Security" },
{ message = "^revert", group = "Reverted" },
]
# Protect breaking changes from being skipped due to matching a skipping commit_parser
protect_breaking_commits = false
# Filter commits by their patterns
filter_commits = false
# Sort commits by date within each group
topo_order = false
# Sort commits within each group by their messages
sort_commits = "oldest"
# Regex for matching git tags
tag_pattern = "v[0-9].*"
# Regex for skipping tags
skip_tags = ""
# Regex for ignoring tags
ignore_tags = ""
# Link parsers for issue/PR references
link_parsers = [
{ pattern = "#(\\d+)", href = "https://github.com/NavalToolbox/navaltoolbox-lib/issues/$1" },
{ pattern = "RFC(\\d+)", text = "ietf-rfc$1", href = "https://datatracker.ietf.org/doc/html/rfc$1" },
]
# Limit the number of commits per group
limit_commits = 0