https://github.com/becklyn/release-notes-generator

https://github.com/becklyn/release-notes-generator

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/becklyn/release-notes-generator
• Owner: Becklyn
• License: bsd-3-clause
• Created: 2019-12-05T13:27:51.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-01-05T04:56:14.000Z (over 2 years ago)
• Last Synced: 2025-01-14T03:14:07.070Z (4 months ago)
• Language: TypeScript
• Size: 2.13 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
Release Notes Generator

=======================

>   **Online available at [release-notes.becklyn.tech](https://release-notes.becklyn.tech/).**

Changelog Format

----------------

The entry must be a list. Every top-level list item must have the format:

```md

*   (type) text

```

where `type` is one of the types below and `text` is just free text.

### Supported Types

| Type              | Label                 | Description                       |

| ----------------- | --------------------- | --------------------------------- |

| `(bc)`            | **Breaking Changes**  | Changes that break previously working code. Implies major version bump! |

| `feature`         | **New Features**      | New features added, that add new functionality to the library. Implies at least minor version bump! |

| `(improvement)`   | **Improvements**      | Things that work better or in more cases than before. |

| `(bug)`           | **Bugfixes**          | Things that should have worked before (but didn't), but do work now. |

| `(deprecation)`   | **Deprecations**      | Lists all added deprecations. |

| `(docs)`          | **Documentation**     | Changes in the documentation. |

| `(internal)`      | **Internal**          | Internal changes / refactorings that should have no functional impact on the end user. |