docs(log): conventional commits
This commit is contained in:
parent
47aaa4bb32
commit
d222fd84a5
3 changed files with 52 additions and 0 deletions
32
doc/log/archive/2023/04/1681123651/index.md
Normal file
32
doc/log/archive/2023/04/1681123651/index.md
Normal file
|
@ -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.
|
10
doc/log/archive/2023/04/index.md
Normal file
10
doc/log/archive/2023/04/index.md
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
# 04
|
||||||
|
|
||||||
|
```{toctree}
|
||||||
|
---
|
||||||
|
maxdepth: 1
|
||||||
|
glob:
|
||||||
|
---
|
||||||
|
|
||||||
|
*/index
|
||||||
|
```
|
10
doc/log/archive/2023/index.md
Normal file
10
doc/log/archive/2023/index.md
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
# 2023
|
||||||
|
|
||||||
|
```{toctree}
|
||||||
|
---
|
||||||
|
maxdepth: 1
|
||||||
|
glob:
|
||||||
|
---
|
||||||
|
|
||||||
|
*/index
|
||||||
|
```
|
Loading…
Reference in a new issue