Skip to content

Commit

Permalink
docs: add example output
Browse files Browse the repository at this point in the history
  • Loading branch information
scottmckendry committed Jan 16, 2025
1 parent c906d8d commit 6608370
Showing 1 changed file with 38 additions and 0 deletions.
38 changes: 38 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,44 @@ Parse _most_ changelog formats into common structured data formats.

`cl-parse` is a command-line tool that converts various changelog formats into structured data (JSON, YAML, or TOML). It supports changelogs generated by popular tools like `release-please` and `semantic-release`, making it easier to programmatically work with changelog data.

### 🎭 Example Transformation

Input (`CHANGELOG.md`):

```markdown
## [0.4.0](https://github.com/scottmckendry/cl-parse/compare/v0.3.0...v0.4.0) (2025-01-14)

### Features

- **cmd:** `format` option with new YAML & TOML outputs ([7ffb283](https://github.com/scottmckendry/cl-parse/commit/7ffb283))
- **origin:** add support for github issue lookup ([539c4cd](https://github.com/scottmckendry/cl-parse/commit/539c4cd)), closes [#2](https://github.com/scottmckendry/cl-parse/issues/2)
```

Command:

```bash
cl-parse --format yaml --include-body --fetch-item-details -latest
```

Output:

```yaml
version: 0.4.0
date: 2025-01-14T00:00:00Z
compareUrl: https://github.com/scottmckendry/cl-parse/compare/v0.3.0...v0.4.0
changes:
Features:
- description: "**cmd:** `format` option with new YAML & TOML outputs"
commit: 7ffb283
- description: "**origin:** add support for github issue lookup"
commit: 539c4cd
commitBody: "adds new flag --fetch-item-details to fetch related items\n\nResolves #2"
relatedItems:
- number: 2
title: "Feature: Programatically Fetch content from PRs and Issues"
body: "Add an option to support the lookup of PRs and issues..."
```
## ✨ Features
- Parses conventional changelog formats
Expand Down

0 comments on commit 6608370

Please sign in to comment.