PHPackages                             saeidsharafi/changelog - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. saeidsharafi/changelog

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

saeidsharafi/changelog
======================

a package to show CHANGELOG.md to users

v1.1(1y ago)0281MITPHPPHP ^8.1|^8.2

Since Sep 13Pushed 1y ago1 watchersCompare

[ Source](https://github.com/SaeidSharafi/laravel-changelog)[ Packagist](https://packagist.org/packages/saeidsharafi/changelog)[ Docs](https://github.com/saeidsharafi/changelog)[ RSS](/packages/saeidsharafi-changelog/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (6)Versions (4)Used By (0)

Very short description of the package
=====================================

[](#very-short-description-of-the-package)

[![Latest Version on Packagist](https://camo.githubusercontent.com/55deaa7da861b24d1893d05a488e5025b1a1131e7c621555fe76035c0b9b5045/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7361656964736861726166692f6368616e67656c6f672e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/saeidsharafi/changelog)[![Total Downloads](https://camo.githubusercontent.com/e3af0ed0f16a035155aad3bffc6e24ea49278013e764a0f8f3e24a414564c66d/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7361656964736861726166692f6368616e67656c6f672e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/saeidsharafi/changelog)[![GitHub Actions](https://github.com/saeidsharafi/changelog/actions/workflows/main.yml/badge.svg)](https://github.com/saeidsharafi/changelog/actions/workflows/main.yml/badge.svg)

This is where your description should go. Try and limit it to a paragraph or two, and maybe throw in a mention of what PSRs you support to avoid any confusion with users and contributors.

Installation
------------

[](#installation)

You can install the package via composer:

```
composer require saeidsharafi/changelog
```

Usage
-----

[](#usage)

```
// Usage description here
```

### Testing

[](#testing)

```
composer test
```

### Changelog

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.

Changelog File Formats
----------------------

[](#changelog-file-formats)

This package supports changelogs in **Markdown**, **YAML**, or **JSON** formats. The file is auto-detected in this order: `changelog.yaml`, `changelog.json`, `CHANGELOG.md`.

### YAML Example

[](#yaml-example)

```
- version: 1.2.0
  date: 2025-05-03
  title: "Release Title"
  changes:
    - title: "Added new feature X"
      subtitles:
        - "Subfeature 1"
        - "Subfeature 2"
    - title: "Fixed bug Y"
      subtitles:
        - "Bugfix details"
  notes:
    - "Release note 1"
- version: 1.1.0
  date: 2025-04-01
  title: "Previous Release"
  changes:
    - title: "Improved performance"
      subtitles:
        - "Performance details"
  notes:
    - "Welcome!"
```

### JSON Example

[](#json-example)

```
[
  {
    "version": "1.2.0",
    "date": "2025-05-03",
    "title": "Release Title",
    "changes": [
      { "title": "Added new feature X", "subtitles": ["Subfeature 1", "Subfeature 2"] },
      { "title": "Fixed bug Y", "subtitles": ["Bugfix details"] }
    ],
    "notes": ["Release note 1"]
  },
  {
    "version": "1.1.0",
    "date": "2025-04-01",
    "title": "Previous Release",
    "changes": [
      { "title": "Improved performance", "subtitles": ["Performance details"] }
    ],
    "notes": ["Welcome!"]
  }
]
```

### Markdown Example

[](#markdown-example)

```
# Changelog

## 1.2.0 - 2025-05-03
**Release Title**

> [!NOTE] Please fill in the following structure manually.
```yaml
version: 1.2.0
date: 2025-05-03
title: Release Title
changes:
  - title: Added new feature X
    subtitles:
      - Subfeature 1
      - Subfeature 2
  - title: Fixed bug Y
    subtitles:
      - Bugfix details
notes:
  - Release note 1

```

1.1.0 - 2025-04-01
------------------

[](#110---2025-04-01)

**Previous Release**

> \[!NOTE\] Please fill in the following structure manually.

```
version: 1.1.0
date: 2025-04-01
title: Previous Release
changes:
  - title: Improved performance
    subtitles:
      - Performance details
notes:
  - Welcome!
```

```

## Artisan Command: changelog:entry

You can scaffold a new changelog entry using:

```bash
php artisan changelog:entry --app-version=1.3.0 --date=2025-06-01 --silent

```

**Options:**

- `--file` Specify a custom changelog file path (overrides autodetect, e.g. `--file=/path/to/changelog.yaml`)
- `--app-version` Version number (e.g. 1.3.0)
- `--date` Release date (YYYY-MM-DD)
- `--silent` Silently create a placeholder entry without prompts

If options are omitted, you will be prompted interactively for version, date, title, changes (with subtitles), and notes.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

### Security

[](#security)

If you discover any security related issues, please email  instead of using the issue tracker.

Credits
-------

[](#credits)

- [Saeid Sharafi](https://github.com/saeidsharafi)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

Laravel Package Boilerplate
---------------------------

[](#laravel-package-boilerplate)

This package was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com).

###  Health Score

33

—

LowBetter than 75% of packages

Maintenance49

Moderate activity, may be stable

Popularity11

Limited adoption so far

Community7

Small or concentrated contributor base

Maturity54

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~231 days

Total

2

Last Release

373d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/70821e746e348da6d87c64389f6a1e5babb1015a25d50f2bc5b93a87a7a002c3?d=identicon)[SaeidSharafi](/maintainers/SaeidSharafi)

---

Top Contributors

[![SaeidSharafi](https://avatars.githubusercontent.com/u/6916349?v=4)](https://github.com/SaeidSharafi "SaeidSharafi (5 commits)")

---

Tags

changelogsaeidsharafi

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/saeidsharafi-changelog/health.svg)

```
[![Health](https://phpackages.com/badges/saeidsharafi-changelog/health.svg)](https://phpackages.com/packages/saeidsharafi-changelog)
```

###  Alternatives

[barryvdh/laravel-ide-helper

Laravel IDE Helper, generates correct PHPDocs for all Facade classes, to improve auto-completion.

14.9k123.0M687](/packages/barryvdh-laravel-ide-helper)[orchestra/canvas

Code Generators for Laravel Applications and Packages

21017.2M158](/packages/orchestra-canvas)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

255.2k](/packages/aedart-athenaeum)[tehwave/laravel-achievements

Simple, elegant Achievements the Laravel way

7012.8k](/packages/tehwave-laravel-achievements)[interaction-design-foundation/laravel-geoip

Support for multiple Geographical Location services.

17221.0k3](/packages/interaction-design-foundation-laravel-geoip)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
