Filament Changelog

Appearance

Getting Started ​

Enable the plugin by adding it to your PanelProvider and choosing where the changelog comes from.

GitHub Releases ​

Provide your GitHub repo and a personal access token via the ->github() method. You can find more info on how to create an access token via the GitHub Docs.

php
$panel->plugins([
    ChangelogPlugin::make()
        ->github('REPO', 'TOKEN');
])

Markdown Files ​

Read the changelog from Markdown files in your repository, optionally one changelog per audience. See Markdown Files for the folder structure and file format.

php
$panel->plugins([
    ChangelogPlugin::make()
        ->files(base_path('changelog'), audience: 'admins');
])

Deployment ​

You should add php artisan changelog:get to your deployment script. It clears the cache and fetches the latest releases for every panel.

Tracking Seen Versions ​

You can track the user's last viewed release tag by using the ->trackUserVersion() method.

php
$panel->plugins([
    ChangelogPlugin::make()
        ->github('REPO', 'TOKEN')
        ->trackUserVersion('user_column');
])