From d222fd84a5ceb22b2c9d9716ada1a1cf85c3afdb Mon Sep 17 00:00:00 2001 From: Renken Date: Mon, 10 Apr 2023 14:45:52 +0200 Subject: [PATCH] docs(log): conventional commits --- doc/log/archive/2023/04/1681123651/index.md | 32 +++++++++++++++++++++ doc/log/archive/2023/04/index.md | 10 +++++++ doc/log/archive/2023/index.md | 10 +++++++ 3 files changed, 52 insertions(+) create mode 100644 doc/log/archive/2023/04/1681123651/index.md create mode 100644 doc/log/archive/2023/04/index.md create mode 100644 doc/log/archive/2023/index.md diff --git a/doc/log/archive/2023/04/1681123651/index.md b/doc/log/archive/2023/04/1681123651/index.md new file mode 100644 index 0000000..1aa67b4 --- /dev/null +++ b/doc/log/archive/2023/04/1681123651/index.md @@ -0,0 +1,32 @@ +# Conventional commits +*Written 2023-04-10 12:47* + +```{contents} +``` + +I recently came across [conventional +commits](https://www.conventionalcommits.org/en/v1.0.0/) and I find the idea +very interesting and practical. The commit message style is similar to my +subjective style except it's standardized and most importantly parsable. The end +goal is to automatically generate changelogs following [keep a +changelog](https://keepachangelog.com/en/1.0.0/). + +I found a couple of tools which does this. + +## commitizen + +[commitizen](https://github.com/commitizen-tools/commitizen) is good if you use +the default config. However, as soon as you derive from the latter, you'd need +to write your own customized parsing config which I found to be somewhat +difficult to write considering how sometimes commitizen crashes if your config +is invalid. + +I like how nicely it generates changelogs for you, I should probably take more +time to write a working custom config that suits my needs. + +## git-cliff + +[git-cliff](https://github.com/orhun/git-cliff) looks very interesting as well. +It is similar to commitizen. However the command arguments feel more natural to +me I feel. I quickly tried it out, I remember `link_parsers` not working but it +might've been a misconfiguration on my end. We'll see. diff --git a/doc/log/archive/2023/04/index.md b/doc/log/archive/2023/04/index.md new file mode 100644 index 0000000..7712677 --- /dev/null +++ b/doc/log/archive/2023/04/index.md @@ -0,0 +1,10 @@ +# 04 + +```{toctree} +--- +maxdepth: 1 +glob: +--- + +*/index +``` diff --git a/doc/log/archive/2023/index.md b/doc/log/archive/2023/index.md new file mode 100644 index 0000000..19b1e7d --- /dev/null +++ b/doc/log/archive/2023/index.md @@ -0,0 +1,10 @@ +# 2023 + +```{toctree} +--- +maxdepth: 1 +glob: +--- + +*/index +```