orhun/git-cliff
1
1
Fork 0
mirror of https://github.com/orhun/git-cliff.git synced 2024-09-11 06:55:38 +03:00
Code Issues Projects Releases Wiki Activity

style(changelog): comply with MD022 and fix minor typos (#61)

Browse Source 
* style: add newlines after the title to comply with MD022

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>

* style: replace whitespaces with whitespace

Signed-off-by: Kenji Miyake <kenji.miyake@tier4.jp>
This commit is contained in:
Kenji Miyake 2022-02-09 00:11:11 +09:00 committed by GitHub
parent e1da61150f
commit 0293b28109
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
10 changed files with 29 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
.github/fixtures/cliff.toml vendored
View File

@ -3,7 +3,7 @@
[changelog] [changelog]
# changelog header # changelog header
header = """ header = """
# Changelog # Changelog\n
All notable changes to this project will be documented in this file.\n All notable changes to this project will be documented in this file.\n
""" """
# template for the changelog body # template for the changelog body
@ -21,7 +21,7 @@ body = """
{% endfor %} {% endfor %}
{% endfor %}\n {% endfor %}\n
""" """
# remove the leading and trailing whitespaces from the template # remove the leading and trailing whitespace from the template
trim = true trim = true
# changelog footer # changelog footer
footer = """ footer = """

1
.github/fixtures/expected.md vendored
View File

@ -1,4 +1,5 @@
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [0.2.0] - 2021-01-23 ## [0.2.0] - 2021-01-23

1
CHANGELOG.md
View File

@ -1,4 +1,5 @@
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [0.5.0] - 2021-12-15 ## [0.5.0] - 2021-12-15

14
README.md
View File

@ -375,7 +375,7 @@ See [templating](#templating) for more detail.
#### trim #### trim
If set to `true`, leading and trailing whitespaces are removed from the [body](#body). If set to `true`, leading and trailing whitespace are removed from the [body](#body).
It is useful for adding indentation to the template for readability, as shown [in the example](#changelog). It is useful for adding indentation to the template for readability, as shown [in the example](#changelog).
@ -665,6 +665,7 @@ If you have a custom configuration file that you are using for your project(s),
``` ```
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [unreleased] ## [unreleased]
@ -708,6 +709,7 @@ All notable changes to this project will be documented in this file.
<summary>Rendered Output</summary> <summary>Rendered Output</summary>
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [unreleased] ## [unreleased]
@ -813,6 +815,7 @@ All notable changes to this project will be documented in this file.
``` ```
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [unreleased] ## [unreleased]
@ -858,6 +861,7 @@ All notable changes to this project will be documented in this file.
<summary>Rendered Output</summary> <summary>Rendered Output</summary>
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [unreleased] ## [unreleased]
@ -905,6 +909,7 @@ All notable changes to this project will be documented in this file.
``` ```
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [unreleased] ## [unreleased]
@ -966,6 +971,7 @@ All notable changes to this project will be documented in this file.
<summary>Rendered Output</summary> <summary>Rendered Output</summary>
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [unreleased] ## [unreleased]
@ -1029,6 +1035,7 @@ All notable changes to this project will be documented in this file.
``` ```
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [unreleased] ## [unreleased]
@ -1073,6 +1080,7 @@ All notable changes to this project will be documented in this file.
<summary>Rendered Output</summary> <summary>Rendered Output</summary>
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [unreleased] ## [unreleased]
@ -1119,6 +1127,7 @@ All notable changes to this project will be documented in this file.
``` ```
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@ -1165,6 +1174,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
<summary>Rendered Output</summary> <summary>Rendered Output</summary>
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@ -1213,6 +1223,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
``` ```
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [unreleased] ## [unreleased]
@ -1260,6 +1271,7 @@ All notable changes to this project will be documented in this file.
<summary>Rendered Output</summary> <summary>Rendered Output</summary>
# Changelog # Changelog
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [unreleased] ## [unreleased]

4
config/cliff.toml
View File

@ -3,7 +3,7 @@
[changelog] [changelog]
# changelog header # changelog header
header = """ header = """
# Changelog # Changelog\n
All notable changes to this project will be documented in this file.\n All notable changes to this project will be documented in this file.\n
""" """
# template for the changelog body # template for the changelog body
@ -21,7 +21,7 @@ body = """
{% endfor %} {% endfor %}
{% endfor %}\n {% endfor %}\n
""" """
# remove the leading and trailing whitespaces from the template # remove the leading and trailing whitespace from the template
trim = true trim = true
# changelog footer # changelog footer
footer = """ footer = """

4
examples/detailed.toml
View File

@ -3,7 +3,7 @@
[changelog] [changelog]
# changelog header # changelog header
header = """ header = """
# Changelog # Changelog\n
All notable changes to this project will be documented in this file.\n All notable changes to this project will be documented in this file.\n
""" """
# template for the changelog body # template for the changelog body
@ -27,7 +27,7 @@ body = """
{% endfor %} {% endfor %}
{% endfor %}\n {% endfor %}\n
""" """
# remove the leading and trailing whitespaces from the template # remove the leading and trailing whitespace from the template
trim = true trim = true
# changelog footer # changelog footer
footer = """ footer = """

4
examples/keepachangelog.toml
View File

@ -3,7 +3,7 @@
[changelog] [changelog]
# changelog header # changelog header
header = """ header = """
# Changelog # Changelog\n
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@ -24,7 +24,7 @@ body = """
{% endfor %} {% endfor %}
{% endfor %}\n {% endfor %}\n
""" """
# remove the leading and trailing whitespaces from the template # remove the leading and trailing whitespace from the template
trim = true trim = true
# changelog footer # changelog footer
footer = """ footer = """

4
examples/scoped.toml
View File

@ -3,7 +3,7 @@
[changelog] [changelog]
# changelog header # changelog header
header = """ header = """
# Changelog # Changelog\n
All notable changes to this project will be documented in this file.\n All notable changes to this project will be documented in this file.\n
""" """
# template for the changelog body # template for the changelog body
@ -24,7 +24,7 @@ body = """
{% endfor %}\ {% endfor %}\
{% endfor %}\n {% endfor %}\n
""" """
# remove the leading and trailing whitespaces from the template # remove the leading and trailing whitespace from the template
trim = true trim = true
# changelog footer # changelog footer
footer = """ footer = """

4
examples/scopesorted.toml
View File

@ -3,7 +3,7 @@
[changelog] [changelog]
# changelog header # changelog header
header = """ header = """
# Changelog # Changelog\n
All notable changes to this project will be documented in this file.\n All notable changes to this project will be documented in this file.\n
""" """
# template for the changelog body # template for the changelog body
@ -36,7 +36,7 @@ body = """
{% raw %}\n{% endraw %}\ {% raw %}\n{% endraw %}\
{% endfor %}\n {% endfor %}\n
""" """
# remove the leading and trailing whitespaces from the template # remove the leading and trailing whitespace from the template
trim = true trim = true
# changelog footer # changelog footer
footer = """ footer = """

4
examples/unconventional.toml
View File

@ -3,7 +3,7 @@
[changelog] [changelog]
# changelog header # changelog header
header = """ header = """
# Changelog # Changelog\n
All notable changes to this project will be documented in this file.\n All notable changes to this project will be documented in this file.\n
""" """
# template for the changelog body # template for the changelog body
@ -21,7 +21,7 @@ body = """
{% endfor %} {% endfor %}
{% endfor %}\n {% endfor %}\n
""" """
# remove the leading and trailing whitespaces from the template # remove the leading and trailing whitespace from the template
trim = true trim = true
# changelog footer # changelog footer
footer = """ footer = """