From cad43649c37355ed84e7f0c37e9071e7d9d3e06a Mon Sep 17 00:00:00 2001 From: Sietze van Buuren Date: Fri, 8 Nov 2024 17:44:10 +0100 Subject: [PATCH] chore: update templates for genearing the changelog and release notes Also update the current changelog accordingly Signed-off-by: Sietze van Buuren --- CHANGELOG.md | 196 +++------------------------------ templates/.release_notes.md.j2 | 3 +- templates/CHANGELOG.md.j2 | 13 ++- 3 files changed, 21 insertions(+), 191 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 6052b62..30e236f 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,219 +1,49 @@ # CHANGELOG - ## v0.3.0 (2024-11-03) ### Chores -* chore: Add naming to github actions workflows - -Signed-off-by: Sietze van Buuren ([`1fd272c`](https://github.com/swvanbuuren/mlpyqtgraph/commit/1fd272c647f92c539ca020e84e7ea2bcf62e23c6)) +* Add naming to github actions workflows ([`1fd272c`](https://github.com/swvanbuuren/mlpyqtgraph/commit/1fd272c647f92c539ca020e84e7ea2bcf62e23c6)) ### Documentation -* docs: Fix link to installation page - -Signed-off-by: Sietze van Buuren ([`6f41c1f`](https://github.com/swvanbuuren/mlpyqtgraph/commit/6f41c1f7f5ca2cf7a2c39bb36e5038f25ae814bc)) +* Fix link to installation page ([`6f41c1f`](https://github.com/swvanbuuren/mlpyqtgraph/commit/6f41c1f7f5ca2cf7a2c39bb36e5038f25ae814bc)) -* docs: Fix links and typos in documentation - -Signed-off-by: Sietze van Buuren ([`517ae15`](https://github.com/swvanbuuren/mlpyqtgraph/commit/517ae154b340cc9ff60cdaeb7be5928e98532609)) +* Fix links and typos in documentation ([`517ae15`](https://github.com/swvanbuuren/mlpyqtgraph/commit/517ae154b340cc9ff60cdaeb7be5928e98532609)) ### Features -* feat: Add 3D axis grid with automatic tick labels to surf plots - -This is a major update, that introduces a 3D grid with backfaces and tick labels -at nice positions. The different grid sides and tick(s) (labels) are -automatically shown and hirdden depending on the viewing angle. - -This update requires a local modification to the GLTextItems to support -alignment. - -Signed-off-by: Sietze van Buuren ([`ee5a6fb`](https://github.com/swvanbuuren/mlpyqtgraph/commit/ee5a6fbc8423392360c62338c8357ba22f2f9f96)) - - +* Add 3D axis grid with automatic tick labels to surf plots ([`ee5a6fb`](https://github.com/swvanbuuren/mlpyqtgraph/commit/ee5a6fbc8423392360c62338c8357ba22f2f9f96)) ## v0.2.0 (2024-08-20) ### Documentation -* docs: Include PyPi package in installation instructions - -Signed-off-by: Sietze van Buuren ([`f514ec1`](https://github.com/swvanbuuren/mlpyqtgraph/commit/f514ec179daa10414a077025876382ab2d03e335)) +* Include PyPi package in installation instructions ([`f514ec1`](https://github.com/swvanbuuren/mlpyqtgraph/commit/f514ec179daa10414a077025876382ab2d03e335)) ### Features -* feat: Add more festures to full 2D plot example - -Signed-off-by: Sietze van Buuren ([`55c54f4`](https://github.com/swvanbuuren/mlpyqtgraph/commit/55c54f410f34eaf369357edeeb3758301e22efdc)) - - +* Add more festures to full 2D plot example ([`55c54f4`](https://github.com/swvanbuuren/mlpyqtgraph/commit/55c54f410f34eaf369357edeeb3758301e22efdc)) ## v0.1.0 (2024-08-19) ### Bug Fixes -* fix: Align with latest pqthreads version - -Signed-off-by: Sietze van Buuren ([`da98f7e`](https://github.com/swvanbuuren/mlpyqtgraph/commit/da98f7e9f18e14cf22f5f0a9369628a02ed6dc3f)) +* Align with latest pqthreads version ([`da98f7e`](https://github.com/swvanbuuren/mlpyqtgraph/commit/da98f7e9f18e14cf22f5f0a9369628a02ed6dc3f)) ### Chores -* chore: Move to pyproject.toml setup - -Signed-off-by: Sietze van Buuren ([`d52221e`](https://github.com/swvanbuuren/mlpyqtgraph/commit/d52221ec07ebc6708653baec8d746acbb4cf684e)) +* Move to pyproject.toml setup ([`d52221e`](https://github.com/swvanbuuren/mlpyqtgraph/commit/d52221ec07ebc6708653baec8d746acbb4cf684e)) ### Documentation -* docs: Fix typo on Welcome page - -Signed-off-by: Sietze van Buuren ([`5069356`](https://github.com/swvanbuuren/mlpyqtgraph/commit/5069356916a23558427732bf8f1dd9beebaedc69)) +* Fix typo on Welcome page ([`5069356`](https://github.com/swvanbuuren/mlpyqtgraph/commit/5069356916a23558427732bf8f1dd9beebaedc69)) -* docs: Link explicitely to page w/ installation instructions +* Link explicitely to page w/ installation instructions ([`f17b61f`](https://github.com/swvanbuuren/mlpyqtgraph/commit/f17b61f0ccfa95976ea482eea317e09ec2222cf8)) -Signed-off-by: Sietze van Buuren ([`f17b61f`](https://github.com/swvanbuuren/mlpyqtgraph/commit/f17b61f0ccfa95976ea482eea317e09ec2222cf8)) +* Change all documentation links to GH pages ([`af48cab`](https://github.com/swvanbuuren/mlpyqtgraph/commit/af48cabdd4bacb58a572a0a1e55eedc5463717fc)) -* docs: Change all documentation links to GH pages - -Signed-off-by: Sietze van Buuren ([`af48cab`](https://github.com/swvanbuuren/mlpyqtgraph/commit/af48cabdd4bacb58a572a0a1e55eedc5463717fc)) - -* docs: Move documentation to mkdocstrings hosted on GitHub pages - -Signed-off-by: Sietze van Buuren ([`1426d1a`](https://github.com/swvanbuuren/mlpyqtgraph/commit/1426d1a3ae8cf6e1007b102a02199986d9d80a98)) +* Move documentation to mkdocstrings hosted on GitHub pages ([`1426d1a`](https://github.com/swvanbuuren/mlpyqtgraph/commit/1426d1a3ae8cf6e1007b102a02199986d9d80a98)) ### Features -* feat: Add semantic release management and publishing to PyPi - -Signed-off-by: Sietze van Buuren ([`5a44c92`](https://github.com/swvanbuuren/mlpyqtgraph/commit/5a44c9231df5848f7092a3c263075ccad197e82b)) - -### Unknown - -* Update documentation link to GH pages - -Signed-off-by: Sietze van Buuren ([`8ca927f`](https://github.com/swvanbuuren/mlpyqtgraph/commit/8ca927f41325fb28b00af9f5705d464aedfb4e05)) - -* Merge pull request #1 from swvanbuuren/pqthreads-support - -Pqthreads support ([`b1a6828`](https://github.com/swvanbuuren/mlpyqtgraph/commit/b1a68286139557281854d136e332cf926fdd0ad6)) - -* Make a figure is always available - -Signed-off-by: Sietze van Buuren ([`0822832`](https://github.com/swvanbuuren/mlpyqtgraph/commit/0822832ab80d03b21d2c1d632c29e85403c75714)) - -* Working newer setup without subplots - -Signed-off-by: Sietze van Buuren ([`a2c717b`](https://github.com/swvanbuuren/mlpyqtgraph/commit/a2c717b754b529272506d9a6f20036fdbf02befc)) - -* General Axis class introduced to create Axis2D and Axis3D classes and subplot functionality removed - -Signed-off-by: Sietze van Buuren ([`e915ec4`](https://github.com/swvanbuuren/mlpyqtgraph/commit/e915ec495cd1db5bcc4300bf3cd07cb4fa1c5579)) - -* Work in progress in getting pqthreads support - -Signed-off-by: Sietze van Buuren ([`f21d4fd`](https://github.com/swvanbuuren/mlpyqtgraph/commit/f21d4fd257e7d74b80f91c5deb266b00872a6e39)) - -* Add pyopengl as required package - -Signed-off-by: Sietze van Buuren ([`14b4970`](https://github.com/swvanbuuren/mlpyqtgraph/commit/14b497060c6cfea700c907500631558c37df8ca6)) - -* Merge branch 'main' of https://github.com/swvanbuuren/mlpyqtgraph into main - -Signed-off-by: Sietze van Buuren ([`33ced20`](https://github.com/swvanbuuren/mlpyqtgraph/commit/33ced2046955cc28f517eb5e401facb2f63a3190)) - -* Update index.rst - -Remove maxdepth from toctree ([`0a288cf`](https://github.com/swvanbuuren/mlpyqtgraph/commit/0a288cf743fa063949f1b43c09d8d78ea97c322c)) - -* Update index.rst - -Change toc maxdepth ([`2370ea9`](https://github.com/swvanbuuren/mlpyqtgraph/commit/2370ea91126a4c4538bdf6dfcb1dc92b5cd07848)) - -* Align with sphinx v6 and add some extra options - -Signed-off-by: Sietze van Buuren ([`695b408`](https://github.com/swvanbuuren/mlpyqtgraph/commit/695b40832feedd5338ecd5656695c57d56ed15c6)) - -* Remove reduntant link to mlpyqtgraph from toc - -Signed-off-by: Sietze van Buuren ([`53b07e9`](https://github.com/swvanbuuren/mlpyqtgraph/commit/53b07e904a889570d32d7a0a190c970a0daefa3b)) - -* Literal include of examples instead of hard coded - -Signed-off-by: Sietze van Buuren ([`2a02c28`](https://github.com/swvanbuuren/mlpyqtgraph/commit/2a02c285984c0072a665e4c31b1604c9b3724d82)) - -* Update readme file - -* Add links to internal repository files -* Update installation instructions - -Signed-off-by: Sietze van Buuren ([`1128a8d`](https://github.com/swvanbuuren/mlpyqtgraph/commit/1128a8daa5cf347ae6f407e4248acfc1e3854706)) - -* Update version requirement for rtd - -Signed-off-by: Sietze van Buuren ([`33885df`](https://github.com/swvanbuuren/mlpyqtgraph/commit/33885df14d3c75497234fa14c7efb01c020d867b)) - -* Documentation update and configuration options - -* Fill all documentation pages -* Add configuration options -* Separate color class -* Split out examples in separate files - -Signed-off-by: Sietze van Buuren ([`bfe696f`](https://github.com/swvanbuuren/mlpyqtgraph/commit/bfe696fba5c6deff957af1a6445f98d9101d1f5e)) - -* Catch non-existing segmentedLineMode - -Signed-off-by: Sietze van Buuren ([`14165f9`](https://github.com/swvanbuuren/mlpyqtgraph/commit/14165f9bd2f71231918aebcd204b45412f2d354f)) - -* Add pyqtgraph depencies to doc requirements - -Signed-off-by: Sietze van Buuren ([`ac91338`](https://github.com/swvanbuuren/mlpyqtgraph/commit/ac913383ac9667c8817d8d124725eeafa3976aa5)) - -* Add pyqtgraph to doc requirements - -Signed-off-by: Sietze van Buuren ([`8810938`](https://github.com/swvanbuuren/mlpyqtgraph/commit/8810938b5bdc15b7e338b98a301284a8799e9eeb)) - -* Replace PySide2.* with pyqtgraph.Qt.* dependency - -Signed-off-by: Sietze van Buuren ([`adc6e01`](https://github.com/swvanbuuren/mlpyqtgraph/commit/adc6e0100ff4da95874147e02d57f181093f9bbd)) - -* Add required package PySide2 ([`b0d64a1`](https://github.com/swvanbuuren/mlpyqtgraph/commit/b0d64a15529a68977eb4307903079f710d0656f6)) - -* Use os.path in Sphinx conf ([`d6524c5`](https://github.com/swvanbuuren/mlpyqtgraph/commit/d6524c5c09cf9cce4527925055f9f8a7021b70ef)) - -* Update setup.py, use pathlib in sphinx conf ([`be9150b`](https://github.com/swvanbuuren/mlpyqtgraph/commit/be9150bb3a0f77b91182701b49a2d3c32fc8592a)) - -* Ignore __pycache__ directories ([`83ea02c`](https://github.com/swvanbuuren/mlpyqtgraph/commit/83ea02c189f677967db0700c2c504c43750873ab)) - -* Added package info to setup.py, fix sphinx conf ([`0e3ae16`](https://github.com/swvanbuuren/mlpyqtgraph/commit/0e3ae16e596c997e9092575b87b256ed4e288e8c)) - -* Added link to documentation in README ([`eb3c760`](https://github.com/swvanbuuren/mlpyqtgraph/commit/eb3c7603c48bf19a9e41978a84b69077d2a0bf57)) - -* Fix rtd doc generation ([`1b23e5f`](https://github.com/swvanbuuren/mlpyqtgraph/commit/1b23e5f2820ddebd581d3d110f76c0046bd80ad8)) - -* Fix package path in sphinx configuration ([`cac9795`](https://github.com/swvanbuuren/mlpyqtgraph/commit/cac979579641eecb8cf8d3b943500d9af3ae7585)) - -* Fix package path in sphinx configuration ([`6b3eade`](https://github.com/swvanbuuren/mlpyqtgraph/commit/6b3eaded6fcdd1cb9c8cde1aa0935cd6ff8c6273)) - -* Fix documentation configuration ([`73fc151`](https://github.com/swvanbuuren/mlpyqtgraph/commit/73fc151703196875f630267ea719355c63baee93)) - -* Change documentation configuration ([`f08e8a8`](https://github.com/swvanbuuren/mlpyqtgraph/commit/f08e8a87a41a5838f474312204bb7e4de783d9f7)) - -* Add requirements and documentation configuration ([`d416151`](https://github.com/swvanbuuren/mlpyqtgraph/commit/d416151319c95c97b4453cedf07f58737a10956a)) - -* Correct links in README ([`bdd3b04`](https://github.com/swvanbuuren/mlpyqtgraph/commit/bdd3b0470898f99da488c419461f0e24c2bacfc7)) - -* Correct install command in README file ([`9579219`](https://github.com/swvanbuuren/mlpyqtgraph/commit/9579219cc26ab7b6059c44645e1e0effbe91c230)) - -* Update README file ([`84d27c7`](https://github.com/swvanbuuren/mlpyqtgraph/commit/84d27c7166ec98f6e76faf0f95812ec94e044854)) - -* Update MANIFEST.in ([`e7f4da1`](https://github.com/swvanbuuren/mlpyqtgraph/commit/e7f4da12000cd3fad1ce56c0a88812fa490a1a22)) - -* Untrack .vscode/ ([`344ce18`](https://github.com/swvanbuuren/mlpyqtgraph/commit/344ce18e5f3563d32804a3703f9e8fd51865dd81)) - -* Initial Sphinx documentation, ignore directories ([`50d8b13`](https://github.com/swvanbuuren/mlpyqtgraph/commit/50d8b1301519913aa5bf32224ef0b519ca63a34a)) - -* Corrected license type in Readme file ([`df4d7ea`](https://github.com/swvanbuuren/mlpyqtgraph/commit/df4d7ea55cb220e506ab0f281a858dae09c942a3)) - -* Change readme title/text ([`cd20f21`](https://github.com/swvanbuuren/mlpyqtgraph/commit/cd20f21acf4d2c48ebd17182e3597021cd5dc7e0)) - -* Initial commit ([`798a42c`](https://github.com/swvanbuuren/mlpyqtgraph/commit/798a42cd35b1a0c31621dce25a0f46475a15ed49)) +* Add semantic release management and publishing to PyPi ([`5a44c92`](https://github.com/swvanbuuren/mlpyqtgraph/commit/5a44c9231df5848f7092a3c263075ccad197e82b)) diff --git a/templates/.release_notes.md.j2 b/templates/.release_notes.md.j2 index 84f9ef3..4fc1215 100644 --- a/templates/.release_notes.md.j2 +++ b/templates/.release_notes.md.j2 @@ -17,9 +17,8 @@ }}{% for commit in commits %}{{ - "\n* %s by %s ([`%s`](%s))\n" | format( + "\n* %s ([`%s`](%s))\n" | format( commit.descriptions[0].rstrip(), - commit.author.name, commit.short_hash, commit.hexsha | commit_hash_url, ) diff --git a/templates/CHANGELOG.md.j2 b/templates/CHANGELOG.md.j2 index 615c805..c4da347 100644 --- a/templates/CHANGELOG.md.j2 +++ b/templates/CHANGELOG.md.j2 @@ -2,19 +2,20 @@ {% for version, release in ctx.history.released.items() %}{{ - "## %s (%s)" | format(version.as_tag(), release.tagged_date.strftime("%Y-%m-%d")) + "## %s (%s)\n" | format(version.as_tag(), release.tagged_date.strftime("%Y-%m-%d")) -}}{% for type_, commits in release["elements"] if type_ != "unknown" | dictsort +}}{% set commit_objects = release["elements"] | dictsort +%}{# +#}{% for type_, commits in commit_objects if type_ != "unknown" %}{{ - "### %s" | format(type_ | title) + "\n### %s\n" | format(type_ | title) }}{% for commit in commits %}{{ - "\n* %s by %s ([`%s`](%s))\n" | format( + "\n* %s ([`%s`](%s))\n" | format( commit.descriptions[0].rstrip(), - commit.author.name, commit.short_hash, - commit.hexsha | commit_hash_url, + commit.hexsha | commit_hash_url ) }}{% endfor