docs: new changelog

[slevang]

Bullet 2/3 on #126. I tried out a few changelog generators and liked this one best. PR is a WIP because I don't know how to make the GH Actions actually play together. As the release job is written here the changelog is generated but lost.

You can install git-cliff locally and run with git cliff -o CHANGELOG.md. Lots of configurable options and we could probably use more filtering, but what I currently have looks like this (for example):

2.2.0 - 2023-11-20

Bug Fixes

• test loaded model vs transform not scores - (a9d6bdf) - Sam Levang
• update to handle v8 semantic release GH action (fix: update to handle v8 semantic release GH action #127) - (5b8c6d8) - Sam Levang

Documentation

• (CHANGELOG) update release notes - (42b5c5e) - Niclas Rieger
• (changelog) use PAT instead of GITHUB_TOKEN - (fa58532) - Niclas Rieger

Features

• normalized option in inverse_transform - (e7d6d90) - Sam Levang
• support saving to netcdf (feat: support saving to netcdf #123) - (8d06153) - Sam Levang
• normalized option in inverse_transform (feat: normalized option in inverse_transform #124) - (4ad2791) - Sam Levang

Miscellaneous

• add workflow dispatch to Github Action - (26f8345) - Niclas Rieger
• release v2.2.0 (chore: release v2.2.0 #128) - (ef40a8a) - Niclas Rieger
• specify Python Semantic Release version v8.0.0 - (c7c79e4) - Niclas Rieger

[codecov-commenter]

Codecov Report

Attention: 66 lines in your changes are missing coverage. Please review.

Comparison is base (0f95d04) 94.21% compared to head (ccac889) 94.31%.
Report is 52 commits behind head on main.

Files	Patch %	Lines
xeofs/utils/numba_utils.py	20.96%	49 Missing ⚠️
xeofs/data_container/data_container.py	88.88%	3 Missing ⚠️
xeofs/preprocessing/stacker.py	72.72%	3 Missing ⚠️
xeofs/models/_base_cross_model.py	96.07%	2 Missing ⚠️
xeofs/models/_base_model.py	96.07%	2 Missing ⚠️
xeofs/models/decomposer.py	86.66%	2 Missing ⚠️
xeofs/preprocessing/preprocessor.py	88.88%	2 Missing ⚠️
xeofs/utils/xarray_utils.py	88.88%	2 Missing ⚠️
xeofs/utils/io.py	97.95%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #141      +/-   ##
==========================================
+ Coverage   94.21%   94.31%   +0.09%     
==========================================
  Files          71       73       +2     
  Lines        5823     6083     +260     
==========================================
+ Hits         5486     5737     +251     
- Misses        337      346       +9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[nicrie]

that looks really nice, I'll take a look and will play around with it to see whether we can make it work with Github Actions.

PS: sorry got confused about the different PRs and deleted the all_contrbutorsrc file from the wrong PR ;)

[slevang]

Just needed to git add the CHANGELOG. We should probably experiment with the cliff.toml specs a bit more before merging but otherwise this should work now if we like it.

[nicrie]

Sorry for the late reply - I’ve been playing around with the cliff.toml file to fine-tune our changelog. Here’s a screenshot of what I think looks good, but it's all pretty subjective, so I’m totally up for changing things up if you have other ideas. Just to summarize:

1. Ordering of categories: Always start with Features, Performance, Bug fixes, and then the rest.
2. Added some icons: This should help with visual sorting and make things look a bit more organized.

One thing that’s still bugging me is how release messages like release v2.2.0 end up under Miscellaneous. It feels kind of redundant since it just repeats the title. I’d rather skip these commit messages altogether, but that’s just me. I’m cool with whatever you prefer! :)

[slevang]

That looks great to me @nicrie. Feel free to push up your changes. I found and noted the one tweak we need to skip the release commits getting included.

[nicrie]

seems that we need this pattern here to ignore the release commits

EDIT: sry somehow my vscode got confused - I meant to replace "^chore\\(release\\):" with "^chore: release"

[slevang]

Looks good to me!

[nicrie]

Fantastic, thanks @slevang for the initiative - I wait for the CI and then I'll hit the button.