Skip to main content

Examples

Examples are based on the following Git history:

* df6aef4 (HEAD -> master) feat(cache): use cache while fetching pages
* a9d4050 feat(config): support multiple file formats
* 06412ac (tag: v1.0.1) chore(release): add release script
* e4fd3cf refactor(parser): expose string functions
* ad27b43 (tag: v1.0.0) docs(example)!: add tested usage example
* 9add0d4 fix(args): rename help argument due to conflict
* a140cef feat(parser): add ability to parse arrays
* 81fbc63 docs(project): add README.md
* a78bc36 Initial commit

Test repository can be found here.

See examples directory for example configuration files.

If you have a custom configuration file that you are using for your project(s), consider sharing it with us by submitting a pull request!

Basic (default)​

Raw Output
# Changelog

All notable changes to this project will be documented in this file.

## [unreleased]

### Features

- Support multiple file formats
- Use cache while fetching pages

## [1.0.1] - 2021-07-18

### Miscellaneous Tasks

- Add release script

### Refactor

- Expose string functions

## [1.0.0] - 2021-07-18

### Bug Fixes

- Rename help argument due to conflict

### Documentation

- Add README.md
- Add tested usage example

### Features

- Add ability to parse arrays

<!-- generated by git-cliff -->
Rendered Output

Changelog

All notable changes to this project will be documented in this file.

unreleased​

Features​

  • Support multiple file formats
  • Use cache while fetching pages

1.0.1 - 2021-07-18​

Miscellaneous Tasks​

  • Add release script

Refactor​

  • Expose string functions

[1.0.0] - 2021-07-18​

Bug Fixes​

  • Rename help argument due to conflict

Documentation​

  • Add README.md
  • Add tested usage example

Features​

  • Add ability to parse arrays

Styled and scoped​

Raw Output
# Changelog

All notable changes to this project will be documented in this file.

## [unreleased]

### ⛰️  Features

- *(cache)* Use cache while fetching pages
- *(config)* Support multiple file formats

## [1.0.1] - 2021-07-18

### 🚜 Refactor

- *(parser)* Expose string functions

### ⚙️ Miscellaneous Tasks

- *(release)* Add release script

## [1.0.0] - 2021-07-18

### ⛰️  Features

- *(parser)* Add ability to parse arrays

### 🐛 Bug Fixes

- *(args)* Rename help argument due to conflict

### 📚 Documentation

- *(example)* [**breaking**] Add tested usage example
- *(project)* Add README.md

<!-- generated by git-cliff -->
Rendered Output

Changelog

All notable changes to this project will be documented in this file.

unreleased​

⛰️ Features​

  • (cache) Use cache while fetching pages
  • (config) Support multiple file formats

1.0.1 - 2021-07-18​

🚜 Refactor​

  • (parser) Expose string functions

⚙️ Miscellaneous Tasks​

  • (release) Add release script

[1.0.0] - 2021-07-18​

⛰️ Features​

  • (parser) Add ability to parse arrays

🐛 Bug Fixes​

  • (args) Rename help argument due to conflict

📚 Documentation​

  • (example) [breaking] Add tested usage example
  • (project) Add README.md

Keep a Changelog​

Raw Output
# Changelog

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/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added

- Support multiple file formats

### Changed

- Use cache while fetching pages

## [1.0.1] - 2021-07-18

### Added

- Add release script

### Changed

- Expose string functions

## [1.0.0] - 2021-07-18

### Added

- Add tested usage example
- Add ability to parse arrays
- Add README.md

### Changed

- Initial commit

### Fixed

- Rename help argument due to conflict

[unreleased]: https://github.com/orhun/git-cliff-readme-example/compare/v1.0.1..HEAD
[1.0.1]: https://github.com/orhun/git-cliff-readme-example/compare/v1.0.0..v1.0.1

<!-- generated by git-cliff -->
Rendered Output

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased​

Added​

  • Support multiple file formats

Changed​

  • Use cache while fetching pages

1.0.1 - 2021-07-18​

Added​

  • Add release script

Changed​

  • Expose string functions

[1.0.0] - 2021-07-18​

Added​

  • Add tested usage example
  • Add ability to parse arrays
  • Add README.md

Changed​

  • Initial commit

Fixed​

  • Rename help argument due to conflict

GitHub​

Raw Output
## What's Changed
* feat(cache): use cache while fetching pages by @orhun
* feat(config): support multiple file formats by @orhun

## What's Changed in v1.0.1
* chore(release): add release script by @orhun
* refactor(parser): expose string functions by @orhun

**Full Changelog**: https://github.com/orhun/git-cliff-readme-example/compare/v1.0.0...v1.0.1

## What's Changed in v1.0.0
* docs(example)!: add tested usage example by @orhun
* fix(args): rename help argument due to conflict by @orhun
* feat(parser): add ability to parse arrays by @orhun
* docs(project): add README.md by @orhun
* Initial commit by @orhun

<!-- generated by git-cliff -->
Rendered Output

What's Changed​

  • feat(cache): use cache while fetching pages by @orhun
  • feat(config): support multiple file formats by @orhun

What's Changed in v1.0.1​

  • chore(release): add release script by @orhun
  • refactor(parser): expose string functions by @orhun

Full Changelog: https://github.com/orhun/git-cliff-readme-example/compare/v1.0.0...v1.0.1

What's Changed in v1.0.0​

  • docs(example)!: add tested usage example by @orhun
  • fix(args): rename help argument due to conflict by @orhun
  • feat(parser): add ability to parse arrays by @orhun
  • docs(project): add README.md by @orhun
  • Initial commit by @orhun

GitHub + Keep a Changelog​

Raw Output
# Changelog

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/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added
- Support multiple file formats by @orhun

### Changed
- Use cache while fetching pages by @orhun

## [1.0.1] - 2021-07-18

### Added
- Add release script by @orhun

### Changed
- Expose string functions by @orhun

## [1.0.0] - 2021-07-18

### Added
- Add tested usage example by @orhun
- Add ability to parse arrays by @orhun
- Add README.md by @orhun

### Changed
- Initial commit by @orhun

### Fixed
- Rename help argument due to conflict by @orhun

[unreleased]: https://github.com/orhun/git-cliff-readme-example/compare/v1.0.1..HEAD
[1.0.1]: https://github.com/orhun/git-cliff-readme-example/compare/v1.0.0..v1.0.1

<!-- generated by git-cliff -->
Rendered Output

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased​

Added​

  • Support multiple file formats by @orhun

Changed​

  • Use cache while fetching pages by @orhun

1.0.1 - 2021-07-18​

Added​

  • Add release script by @orhun

Changed​

  • Expose string functions by @orhun

[1.0.0] - 2021-07-18​

Added​

  • Add tested usage example by @orhun
  • Add ability to parse arrays by @orhun
  • Add README.md by @orhun

Changed​

  • Initial commit by @orhun

Fixed​

  • Rename help argument due to conflict by @orhun

Minimal​

Raw Output
## Unreleased
### Feat
- Support multiple file formats
- Use cache while fetching pages

## 1.0.1 - 2021-07-18
### Chore
- Add release script

### Refactor
- Expose string functions

## 1.0.0 - 2021-07-18
### Docs
- Add README.md
- [**breaking**] Add tested usage example

### Feat
- Add ability to parse arrays

### Fix
- Rename help argument due to conflict
Rendered Output

Unreleased​

Feat​

  • Support multiple file formats
  • Use cache while fetching pages

1.0.1 - 2021-07-18​

Chore​

  • Add release script

Refactor​

  • Expose string functions

1.0.0 - 2021-07-18​

Docs​

  • Add README.md
  • [breaking] Add tested usage example

Feat​

  • Add ability to parse arrays

Fix​

  • Rename help argument due to conflict

Detailed​

Raw Output
# Changelog

All notable changes to this project will be documented in this file.

## Unreleased

### Features

- Support multiple file formats ([a9d4050](a9d4050212a18f6b3bd76e2e41fbb9045d268b80))
- Use cache while fetching pages ([df6aef4](df6aef41292f3ffe5887754232e6ea7831c50ba5))

## 1.0.1 - 2021-07-18

[ad27b43](ad27b43e8032671afb4809a1a3ecf12f45c60e0e)...[06412ac](06412ac1dd4071006c465dde6597a21d4367a158)

### Miscellaneous Tasks

- Add release script ([06412ac](06412ac1dd4071006c465dde6597a21d4367a158))

### Refactor

- Expose string functions ([e4fd3cf](e4fd3cf8e2e6f49c0b57f66416e886c37cbb3715))

## 1.0.0 - 2021-07-18

### Bug Fixes

- Rename help argument due to conflict ([9add0d4](9add0d4616dc95a6ea8b01d5e4d233876b6e5e00))

### Documentation

- Add README.md ([81fbc63](81fbc6365484abf0b4f4b05d384175763ad8db44))
- Add tested usage example ([ad27b43](ad27b43e8032671afb4809a1a3ecf12f45c60e0e))

### Features

- Add ability to parse arrays ([a140cef](a140cef0405e0bcbfb5de44ff59e091527d91b38))

<!-- generated by git-cliff -->
Rendered Output

Changelog

All notable changes to this project will be documented in this file.

Unreleased​

Features​

  • Support multiple file formats (a9d4050)
  • Use cache while fetching pages (df6aef4)

1.0.1 - 2021-07-18​

ad27b43...06412ac

Miscellaneous Tasks​

  • Add release script (06412ac)

Refactor​

  • Expose string functions (e4fd3cf)

[1.0.0] - 2021-07-18​

Bug Fixes​

  • Rename help argument due to conflict (9add0d4)

Documentation​

  • Add README.md (81fbc63)
  • Add tested usage example (ad27b43)

Features​

  • Add ability to parse arrays (a140cef)

Scoped​

Raw Output
# Changelog

All notable changes to this project will be documented in this file.

## Unreleased

### Features

#### Cache

- Use cache while fetching pages

#### Config

- Support multiple file formats

## 1.0.1 - 2021-07-18

### Miscellaneous Tasks

#### Release

- Add release script

### Refactor

#### Parser

- Expose string functions

## 1.0.0 - 2021-07-18

### Bug Fixes

#### Args

- Rename help argument due to conflict

### Documentation

#### Example

- Add tested usage example

#### Project

- Add README.md

### Features

#### Parser

- Add ability to parse arrays

<!-- generated by git-cliff -->
Rendered Output

Changelog

All notable changes to this project will be documented in this file.

Unreleased​

Features​

Cache​

  • Use cache while fetching pages

Config​

  • Support multiple file formats

1.0.1 - 2021-07-18​

Miscellaneous Tasks​

Release​

  • Add release script

Refactor​

Parser​

  • Expose string functions

1.0.0 - 2021-07-18​

Bug Fixes​

Args​

  • Rename help argument due to conflict

Documentation​

Example​

  • Add tested usage example

Project​

  • Add README.md

Features​

Parser​

  • Add ability to parse arrays

Scoped (Sorted)​

Raw Output
# Changelog

All notable changes to this project will be documented in this file.

## Unreleased

### Features

- *(cache)* Use cache while fetching pages
- *(config)* Support multiple file formats

## 1.0.1 - 2021-07-18

### Miscellaneous Tasks

- *(release)* Add release script

### Refactor

- *(parser)* Expose string functions

## 1.0.0 - 2021-07-18

### Bug Fixes

- *(args)* Rename help argument due to conflict

### Documentation

- *(example)* Add tested usage example
  - **BREAKING**: add tested usage example
- *(project)* Add README.md

### Features

- *(parser)* Add ability to parse arrays

<!-- generated by git-cliff -->
Rendered Output

Changelog

All notable changes to this project will be documented in this file.

Unreleased​

Features​

  • (cache) Use cache while fetching pages
  • (config) Support multiple file formats

1.0.1 - 2021-07-18​

Miscellaneous Tasks​

  • (release) Add release script

Refactor​

  • (parser) Expose string functions

1.0.0 - 2021-07-18​

Bug Fixes​

  • (args) Rename help argument due to conflict

Documentation​

  • (example) Add tested usage example
    • BREAKING: add tested usage example
  • (project) Add README.md

Features​

  • (parser) Add ability to parse arrays

Unconventional​

Raw Output
# Changelog

All notable changes to this project will be documented in this file.

## Unreleased

### Features

- feat(config): support multiple file formats
- feat(cache): use cache while fetching pages

## 1.0.1 - 2021-07-18

### Miscellaneous Tasks

- chore(release): add release script

### Refactor

- refactor(parser): expose string functions

## 1.0.0 - 2021-07-18

### Bug Fixes

- fix(args): rename help argument due to conflict

### Documentation

- docs(project): add README.md
- docs(example)!: add tested usage example

### Features

- feat(parser): add ability to parse arrays

### Other (unconventional)

- Initial commit

<!-- generated by git-cliff -->
Rendered Output

Changelog

All notable changes to this project will be documented in this file.

Unreleased​

Features​

  • feat(config): support multiple file formats
  • feat(cache): use cache while fetching pages

1.0.1 - 2021-07-18​

Miscellaneous Tasks​

  • chore(release): add release script

Refactor​

  • refactor(parser): expose string functions

1.0.0 - 2021-07-18​

Bug Fixes​

  • fix(args): rename help argument due to conflict

Documentation​

  • docs(project): add README.md
  • docs(example)!: add tested usage example

Features​

  • feat(parser): add ability to parse arrays

Other (unconventional)​

  • Initial commit

Cocogitto​

(similar to cocogitto's changelog)

Raw Output
# Changelog

All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.

---
## [unreleased]

### Features

- **(cache)** use cache while fetching pages - ([df6aef4](https://github.com/cocogitto/cocogitto/commit/df6aef41292f3ffe5887754232e6ea7831c50ba5)) - orhun
- **(config)** support multiple file formats - ([a9d4050](https://github.com/cocogitto/cocogitto/commit/a9d4050212a18f6b3bd76e2e41fbb9045d268b80)) - orhun

---
## [1.0.1](https://github.com/cocogitto/cocogitto/compare/v1.0.0..v1.0.1) - 2021-07-18

### Miscellaneous Chores

- **(release)** add release script - ([06412ac](https://github.com/cocogitto/cocogitto/commit/06412ac1dd4071006c465dde6597a21d4367a158)) - orhun

### Refactoring

- **(parser)** expose string functions - ([e4fd3cf](https://github.com/cocogitto/cocogitto/commit/e4fd3cf8e2e6f49c0b57f66416e886c37cbb3715)) - orhun

---
## [1.0.0] - 2021-07-18

### Bug Fixes

- **(args)** rename help argument due to conflict - ([9add0d4](https://github.com/cocogitto/cocogitto/commit/9add0d4616dc95a6ea8b01d5e4d233876b6e5e00)) - orhun

### Documentation

- **(example)** [**breaking**] add tested usage example - ([ad27b43](https://github.com/cocogitto/cocogitto/commit/ad27b43e8032671afb4809a1a3ecf12f45c60e0e)) - orhun
- **(project)** add README.md - ([81fbc63](https://github.com/cocogitto/cocogitto/commit/81fbc6365484abf0b4f4b05d384175763ad8db44)) - orhun

### Features

- **(parser)** add ability to parse arrays - ([a140cef](https://github.com/cocogitto/cocogitto/commit/a140cef0405e0bcbfb5de44ff59e091527d91b38)) - orhun

<!-- generated by git-cliff -->
Rendered Output

Changelog

All notable changes to this project will be documented in this file. See conventional commits for commit guidelines.

unreleased​

Features​

  • (cache) use cache while fetching pages - (df6aef4) - orhun
  • (config) support multiple file formats - (a9d4050) - orhun

1.0.1 - 2021-07-18​

Miscellaneous Chores​

  • (release) add release script - (06412ac) - orhun

Refactoring​

  • (parser) expose string functions - (e4fd3cf) - orhun

[1.0.0] - 2021-07-18​

Bug Fixes​

  • (args) rename help argument due to conflict - (9add0d4) - orhun

Documentation​

  • (example) [breaking] add tested usage example - (ad27b43) - orhun
  • (project) add README.md - (81fbc63) - orhun

Features​

  • (parser) add ability to parse arrays - (a140cef) - orhun

Statistics​

Raw Output
# Changelog

All notable changes to this project will be documented in this file.

## Unreleased

### Features

- Support multiple file formats
- Use cache while fetching pages

### Commit Statistics

- 2 commit(s) contributed to the release.
- 0 day(s) passed between the first and last commit.
- 2 commit(s) parsed as conventional.
- 0 linked issue(s) detected in commits.
- 1430 day(s) passed between releases.

## 1.0.1 - 2021-07-18

### Miscellaneous Tasks

- Add release script

### Refactor

- Expose string functions

### Commit Statistics

- 2 commit(s) contributed to the release.
- 0 day(s) passed between the first and last commit.
- 2 commit(s) parsed as conventional.
- 0 linked issue(s) detected in commits.

## 1.0.0 - 2021-07-18

### Bug Fixes

- Rename help argument due to conflict

### Documentation

- Add README.md
- Add tested usage example

### Features

- Add ability to parse arrays

### Other (unconventional)

- Initial commit

### Commit Statistics

- 5 commit(s) contributed to the release.
- 4 day(s) passed between the first and last commit.
- 4 commit(s) parsed as conventional.
- 0 linked issue(s) detected in commits.

<!-- generated by git-cliff -->
Rendered Output

Changelog

All notable changes to this project will be documented in this file.

Unreleased​

Features​

  • Support multiple file formats
  • Use cache while fetching pages

Commit Statistics​

  • 2 commit(s) contributed to the release.
  • 0 day(s) passed between the first and last commit.
  • 2 commit(s) parsed as conventional.
  • 0 linked issue(s) detected in commits.
  • 1430 day(s) passed between releases.

1.0.1 - 2021-07-18​

Miscellaneous Tasks​

  • Add release script

Refactor​

  • Expose string functions

Commit Statistics​

  • 2 commit(s) contributed to the release.
  • 0 day(s) passed between the first and last commit.
  • 2 commit(s) parsed as conventional.
  • 0 linked issue(s) detected in commits.

1.0.0 - 2021-07-18​

Bug Fixes​

  • Rename help argument due to conflict

Documentation​

  • Add README.md
  • Add tested usage example

Features​

  • Add ability to parse arrays

Other (unconventional)​

  • Initial commit

Commit Statistics​

  • 5 commit(s) contributed to the release.
  • 4 day(s) passed between the first and last commit.
  • 4 commit(s) parsed as conventional.
  • 0 linked issue(s) detected in commits.