Skip to content

Commit

Permalink
fix: Capitalize first letter in headings
Browse files Browse the repository at this point in the history
  • Loading branch information
peterdragun authored and tomassebestik committed Jan 6, 2025
1 parent 9e2c54c commit 174e039
Show file tree
Hide file tree
Showing 10 changed files with 75 additions and 67 deletions.
36 changes: 22 additions & 14 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<a href="https://www.espressif.com">
<img src="czespressif/templates/espressif-logo.svg" align="right" height="20" />
<img src="https://www.espressif.com/sites/all/themes/espressif/logo-black.svg" align="right" height="20" />
</a>

# CHANGELOG
Expand All @@ -8,49 +8,57 @@
> This list is not exhaustive - only important changes, fixes, and new features in the code are reflected here.
<div align="center">
<img alt="Static Badge" src="https://img.shields.io/badge/Keep%20a%20Changelog-v1.1.0-salmon?logo=keepachangelog&logoColor=black&labelColor=white&link=https%3A%2F%2Fkeepachangelog.com%2Fen%2F1.1.0%2F">
<img alt="Static Badge" src="https://img.shields.io/badge/Conventional%20Commits-v1.0.0-pink?logo=conventionalcommits&logoColor=black&labelColor=white&link=https%3A%2F%2Fwww.conventionalcommits.org%2Fen%2Fv1.0.0%2F">
<img alt="Static Badge" src="https://img.shields.io/badge/Semantic%20Versioning-v2.0.0-grey?logo=semanticrelease&logoColor=black&labelColor=white&link=https%3A%2F%2Fsemver.org%2Fspec%2Fv2.0.0.html">
<a href="https://keepachangelog.com/en/1.1.0/">
<img alt="Static Badge" src="https://img.shields.io/badge/Keep%20a%20Changelog-v1.1.0-salmon?logo=keepachangelog&logoColor=black&labelColor=white&link=https%3A%2F%2Fkeepachangelog.com%2Fen%2F1.1.0%2F">
</a>
<a href="https://www.conventionalcommits.org/en/v1.0.0/">
<img alt="Static Badge" src="https://img.shields.io/badge/Conventional%20Commits-v1.0.0-pink?logo=conventionalcommits&logoColor=black&labelColor=white&link=https%3A%2F%2Fwww.conventionalcommits.org%2Fen%2Fv1.0.0%2F">
</a>
<a href="https://semver.org/spec/v2.0.0.html">
<img alt="Static Badge" src="https://img.shields.io/badge/Semantic%20Versioning-v2.0.0-grey?logo=semanticrelease&logoColor=black&labelColor=white&link=https%3A%2F%2Fsemver.org%2Fspec%2Fv2.0.0.html">
</a>
</div>
<hr>

## v1.3.0 (2024-10-07)

### ✨ New features
### ✨ New Features

- **pre-commit**: run in pre-push stage *(Fu Hanxi - 11c2d0a)*

### πŸ› Bug fixes
### πŸ› Bug Fixes

- pre-commit entry to support custom args *(Fu Hanxi - 36c6c4a)*

---

## v1.2.0 (2024-10-02)

### ✨ New features
### ✨ New Features

- **test-suite**: add tests changelog/plugin, compare with snapshots (syrupy module) *(Tomas Sebestik - c4d78e3)*

### πŸ› Bug fixes
### πŸ› Bug Fixes

- **changelog**: fix double title, header and footer on 'cz bump' *(Tomas Sebestik - b5a1227)*

### πŸ“– Documentation

- **contributing**: update docs for setup dev environment and testing *(Tomas Sebestik - dfca4d6)*

### πŸ”§ Code refactoring
### πŸ”§ Code Refactoring

- **python-3.9**: refactor syntax and typing for python 3.9 *(Tomas Sebestik - e5a83c6)*

---

## v1.1.0 (2024-09-24)

### ✨ New features
### ✨ New Features

- **changelog**: custom template for release notes (GH action) *(Tomas Sebestik - 19e8cec)*

### πŸ› Bug fixes
### πŸ› Bug Fixes

- **github-actions**: update create-release.yml, missing "v" in version
- (dependabot): update dependabot config file, team reviewers
Expand All @@ -64,15 +72,15 @@

## v1.0.1 (2024-09-10)

### πŸ› Bug fixes
### πŸ› Bug Fixes

- **pre-commit**: change lang from system to python to be able install deps *(Tomas Sebestik - 7443af0)*

---

## v1.0.0 (2024-09-10)

### ✨ New features
### ✨ New Features

- **plugin**: add plugin, commit message questions, changelog template (#1) *(Tomas Sebestik - f2fa815)*

Expand All @@ -86,6 +94,6 @@
<a href="https://www.github.com/espressif/standards">Espressif Standards</a>
</b>
<br>
<sup><a href="https://www.espressif.com">Espressif Systems CO LTD. (2024)</a><sup>
<sup><a href="https://www.espressif.com">Espressif Systems CO LTD. (2025)</a><sup>
</small>
</div>
44 changes: 22 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<img src="https://www.espressif.com/sites/all/themes/espressif/logo-black.svg" alt="Espressif logo" title="Espressif" align="right" height="20" />
</a>

# Commitizen plugin czEspressif
# Commitizen Plugin `czEspressif`

This is a plugin for Commitizen that makes it easy to create and maintain a well-organized and good-looking `CHANGELOG.md`. It also takes care of version bumping and helps you write commit messages that follow Espressif standards.

Expand All @@ -21,7 +21,7 @@ All of this with minimal config and setup, so your `pyproject.toml` file stays c
</a>
<img alt="Static Badge" src="https://img.shields.io/badge/pip%20install-czespressif-black?logo=python&logoColor=white">
<a href="/LICENSE">
<img alt="Project License" src="https://img.shields.io/pypi/l/czespressif"/>\
<img alt="Project License" src="https://img.shields.io/pypi/l/czespressif"/>
</a>
<br>
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors/espressif/cz-plugin-espressif?logo=github&label=Contributors&color=purple">
Expand Down Expand Up @@ -76,7 +76,7 @@ All of this with minimal config and setup, so your `pyproject.toml` file stays c
## Features

- Can be almost zero-config but offers many customization options if your project needs it.
- Predefined **CHANGELOG template** with default categories _Breaking changes / New features / Bug fixes / Documentation / Code refactoring / Removals_.
- Predefined **CHANGELOG template** with default categories _Breaking Changes / New Features / Bug Fixes / Documentation / Code Refactoring / Removals_.
- The CHANGELOG automatically displays commits and the authors of those commits.
- The default order in the changelog categories lists commits with a scope first, followed by the rest, both groups sorted alphabetically.
- Predefined **Release Notes template** that can be used in an automated release workflow.
Expand Down Expand Up @@ -133,7 +133,7 @@ cz example
> In this project's [tests/**snapshots**/test_changelog/](tests/__snapshots__/test_changelog/) directory, we store snapshots used for automated testing. These snapshots **also serve as examples of the plugin's output**.
> You can explore them and compare the plugin output (`test_changelog_czespressif_*.md`) with the default Commitizen output (`test_changelog_cz_default_*.md`), which is generated when our plugin is not used.
### Create Changelog file
### Create Changelog File

If a changelog already exists in your project, make sure you have staged or committed its latest version.

Expand All @@ -143,7 +143,7 @@ This command turns your old changelog into a nicely organized template based on
cz changelog
```

### Bump Release version
### Bump Release Version

Is better to first run:

Expand Down Expand Up @@ -180,15 +180,15 @@ You can check [example without a footer (default)](docs/Release_notes_example.md
> \[!TIP\]
> You can check the implementation of this command in the GitHub workflow [.github/workflows/create-release.yml](.github/workflows/create-release.yml) if you're interested.
### Create commit messages
### Create Commit Messages

In case anyone actually prefers this way of creating commit messages, the command in this plugin is aligned with the Espressif commit linter and DangerJS linters.:

```sh
cz commit
```

```
```txt
? Select the type of change you are committing (Use arrow keys)
» feat ✨ A new feature
fix πŸ› A bug fix
Expand All @@ -201,7 +201,7 @@ cz commit
remove πŸ—‘οΈ Removing code or files
```

### Examples of good commit messages
### Examples of Good Commit Messages

If you are unsure about the commit message standard, run:

Expand All @@ -217,7 +217,7 @@ This will bring up a complete example of good commit messages and commit schema

Config is accepted in `pyproject.toml` (priority, following example), `.cz.toml`, `.cz.json`, `cz.json`, `.cz.yaml`, `cz.yaml`, and `cz.toml`.

### Minimal setup
### Minimal Setup

> \[!TIP\]
> Try to be minimalistic with custom configs. The best approach is to keep the defaults, so all Espressif projects maintain the same look and feel.
Expand All @@ -229,7 +229,7 @@ Config is accepted in `pyproject.toml` (priority, following example), `.cz.toml`
bump_message = 'change(bump): release $current_version β†’ $new_version [skip-ci]'
```

### Optimal setup
### Optimal Setup

```ini
[tool.commitizen]
Expand All @@ -247,7 +247,7 @@ Config is accepted in `pyproject.toml` (priority, following example), `.cz.toml`

```

### Additional configurable parameters
### Additional Configurable Parameters

```ini
[tool.commitizen]
Expand Down Expand Up @@ -289,27 +289,27 @@ Config is accepted in `pyproject.toml` (priority, following example), `.cz.toml`
# - Change orders in which sections displays in the changelog -
# Default: this example is default
change_type_order = [ # with enabled emojis
'🚨 Breaking changes',
'✨ New features',
'πŸ› Bug fixes',
'🚨 Breaking Changes',
'✨ New Features',
'πŸ› Bug Fixes',
'πŸ“– Documentation',
'πŸ”§ Code refactoring',
'πŸ”§ Code Refactoring',
'πŸ—‘οΈ Removals',
'πŸ—οΈ Changes', # in default not in the changelog
'βš™οΈ CI and project settings', # in default not in the changelog
'βš™οΈ CI and Project Settings', # in default not in the changelog
'🚦 Testing', # in default not in the changelog
'πŸ”™ Reverted', # in default not in the changelog
]

change_type_order = [ # same thing, with disabled emojis
'Breaking changes',
'New features',
'Bug fixes',
'Breaking Changes',
'New Features',
'Bug Fixes',
'Documentation',
'Code refactoring',
'Code Refactoring',
'Removals',
'Changes', # in default not in the changelog
'CI and project settings', # in default not in the changelog
'CI and Project Settings', # in default not in the changelog
'Testing', # in default not in the changelog
'Reverted', # in default not in the changelog
]
Expand Down Expand Up @@ -375,7 +375,7 @@ fi
---

## Pre-commit hook (beta)
## Pre-Commit Hook (Beta)

To automatically keep your changelog's "Unreleased" section up to date, add the following to your `.pre-commit-config.yaml` file:

Expand Down
8 changes: 4 additions & 4 deletions czespressif/defaults.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,15 @@
{
'type': 'feat',
'description': 'A new feature',
'heading': 'New features',
'heading': 'New Features',
'emoji': '✨',
'bump': 'MINOR',
'changelog': True,
},
{
'type': 'fix',
'description': 'A bug fix',
'heading': 'Bug fixes',
'heading': 'Bug Fixes',
'emoji': 'πŸ›',
'bump': 'PATCH',
'changelog': True,
Expand All @@ -41,7 +41,7 @@
{
'type': 'refactor',
'description': 'A changeset neither fixing a bug nor adding a feature',
'heading': 'Code refactoring',
'heading': 'Code Refactoring',
'emoji': 'πŸ”§',
'bump': 'PATCH',
'changelog': True,
Expand All @@ -65,7 +65,7 @@
{
'type': 'ci',
'description': 'Changes to CI configuration files and scripts',
'heading': 'CI and project settings',
'heading': 'CI and Project Settings',
'emoji': 'βš™οΈ',
'bump': 'PATCH',
'changelog': False,
Expand Down
2 changes: 1 addition & 1 deletion czespressif/templates/CHANGELOG.md.j2
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{# Release version == e.g. "v4.7.0 (2023-12-13)" #}
{# Sections == e.g. "New features" block, "Bug fixes" block #}
{# Section Title == e.g. "New features" header, "Bug fixes" header #}
{# Section Title == e.g. "New Features" header, "Bug Fixes" header #}
{# Commit record == e.g. "- **stub**: Add ESP32-S3 octal flash support *(Roland Dobai - b746aa7) #}
{# IF-Unreleased section == enable/disable whole block "Unreleased" #}
{# IF-Section line == enable/disable horizontal line between sections #}
Expand Down
4 changes: 2 additions & 2 deletions docs/Release_notes_example.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
### ✨ New features
### ✨ New Features

- **test_esptool**: Added test for embedded and detected flash size match *(Jakub Kocka - c0ea74a)*
- **spi_connection**: Support --spi-connection on all chips *(radim.karnis - 1a38293)*

### πŸ› Bug fixes
### πŸ› Bug Fixes

- **esp32c2**: Added get_flash_cap and get_flash_vendor *(Jakub Kocka - b8dd74d)*
- **testloadram**: Windows assertion error *(Jakub Kocka - cd51bbc)*
Expand Down
4 changes: 2 additions & 2 deletions docs/Release_notes_example_with_footer.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
### ✨ New features
### ✨ New Features

- **test_esptool**: Added test for embedded and detected flash size match _(Jakub Kocka - c0ea74a)_
- **spi_connection**: Support --spi-connection on all chips _(radim.karnis - 1a38293)_

### πŸ› Bug fixes
### πŸ› Bug Fixes

- **esp32c2**: Added get_flash_cap and get_flash_vendor _(Jakub Kocka - b8dd74d)_
- **testloadram**: Windows assertion error _(Jakub Kocka - cd51bbc)_
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@

## v1.3.0 (2024-08-30)

### ✨ New features
### ✨ New Features

- **api**: rollback changes to JWT token handling *(Alice Johnson - b5e7a2d)*
- **ui**: improve loading animations for dashboard page *(Diana White - c5d3e7a)*

### πŸ› Bug fixes
### πŸ› Bug Fixes

- **logging**: switch from console logs to structured JSON logging *(Eve Martin - d9b2c7e)*
- correct typos in error messages displayed on UI *(Bob Smith - b7a4c5b)*
Expand All @@ -36,15 +36,15 @@

## v1.2.0 (2024-07-15)

### πŸ”§ Code refactoring
### πŸ”§ Code Refactoring

- optimize database queries for user data retrieval *(Charlie Green - e7c1d8b)*

---

## v1.2.0.rc0 (2024-06-10)

### πŸ› Bug fixes
### πŸ› Bug Fixes

- **frontend**: correct layout issues in user profile page *(Bob Smith - c3e7b3b)*

Expand All @@ -56,7 +56,7 @@

## v1.1.0 (2024-05-23)

### πŸ› Bug fixes
### πŸ› Bug Fixes

- **api**: update response codes for failed logins *(Bob Smith - 1b7d1e7)*

Expand All @@ -76,23 +76,23 @@

## v0.2.1 (2024-03-29)

### ✨ New features
### ✨ New Features

- **api**: implement new authentication mechanism with JWT tokens *(Alice Johnson - b2c7e8a)*

### πŸ› Bug fixes
### πŸ› Bug Fixes

- resolve null pointer exception in user session management *(Bob Smith - 4b1d62b)*

---

## v0.2.0 (2024-03-02)

### ✨ New features
### ✨ New Features

- **api**: implement new authentication mechanism with JWT tokens *(Alice Johnson - b2c7e8a)*

### πŸ› Bug fixes
### πŸ› Bug Fixes

- resolve null pointer exception in user session management *(Bob Smith - 4b1d62b)*

Expand Down
Loading

0 comments on commit 174e039

Please sign in to comment.