Filament Release Notes

A filamentphp plugin for creating and displaying beautiful release note / changelog pages in Plume

Installation

You can install the package via composer:

composer require meetplume/filament-release-notes

You can publish and run the migrations with:

php artisan vendor:publish --tag="filament-release-notes-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="filament-release-notes-config"

This is the contents of the published config file:

use Plume\FilamentReleaseNotes\Models\ReleaseNote;
use Plume\FilamentReleaseNotes\Policies\ReleaseNotePolicy;
use Plume\FilamentReleaseNotes\Resources\ReleaseNoteResource;

return [
    'models' => [
        'ReleaseNote' => ReleaseNote::class,
    ],
    'policies' => [
        'ReleaseNote' => ReleaseNotePolicy::class,
    ],
    'resources' => [
        'ReleaseNoteResource' => ReleaseNoteResource::class,
    ],
    'can_manage' => true,
    'version_badge_in_admin' => false,
    'version_badge_in_frontend' => false,
    'slug' => 'changelog',
    'has_page' => true,
    'per_page' => 50,
];

Optionally, you can publish the views using

php artisan vendor:publish --tag="filament-release-notes-views"

Add Plugin to your Filament ServiceProvider:

use Plume\FilamentReleaseNotes\FilamentReleaseNotesPlugin;

class AdminPanelProvider extends PanelProvider
{
    public function panel(Panel $panel): Panel
    {
        return $panel
            // [...]
            ->plugins([
                FilamentReleaseNotesPlugin::make(),
            ])

Add source to your app CSS file:

@source '../../../../vendor/meetplume/filament-release-notes/resources/views/*.blade.php';

Testing

composer test

Credits

• CharlieEtienne
• Nicepants

License

The MIT License (MIT). Please see License File for more information.