README

This is where your description should go. Limit it to a paragraph or two. Consider adding a small example.

Support us

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require codecycler/laravel-changelog

Github

You can connect your application to your GitHub repository by adding an env variable with a user access token.

RELEASE_GH_API_KEY=...

You can publish the config file with:

php artisan vendor:publish --tag="laravel-changelog-config"

This is the contents of the published config file:

return [
    /**
     * The adapter being used by the package to get the releases.
     */
    'releaseAdapter' => \Codecycler\Changelog\Adapters\GithubAdapter::class,

    /**
     * The repository which should be used for release lookup.
     */
    'repository' => 'learnkit-dev/rubricsmaken-site',
];

Adjust the config to your needs.

Optionally, you can publish the views using

php artisan vendor:publish --tag="laravel-changelog-views"

Usage

Filament page

You can view the changelog on the /admin/changelog page.

Frontend

<livewire:latest-version-frontend />

Filament dashboard widget

You can register the Codecycler\Changelog\Filament\Widgets\LatestVersion widget to show the latest version on your dashboard.

Testing

Currently there are no tests yet.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

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

codecycler / laravel-changelog

Maintainers

Details