creacoon/laravel-dashboard-gitlab-user-counts-tile

GitLab Tile

1.0.2 2024-09-09 11:21 UTC

Requires

• php: ^8.3
• spatie/laravel-dashboard: ^3.0

Requires (Dev)

• phpunit/phpunit: ^10.5.32
• squizlabs/php_codesniffer: ^3.6.2

MIT

• Juliana Chiabai

• laravel
• dashboard

README

GitLab User Counts Tile

This tile displays user counts from GitLab, including assigned merge requests, review requested merge requests, and todos.

Installation

You can install the tile via composer:

composer require creacoon/laravel-dashboard-gitlab-user-counts-tile

In the dashboard config file, you must add this configuration in the tiles key.

Sign up at your GitLab instance to obtain GITLAB_API_TOKEN

// in config/dashboard.php

return [
    // ...
    'tiles' => [
        'gitlab' => [
            'api_token' => env('GITLAB_API_TOKEN'),
            'api_url' => env('GITLAB_API_URL', 'https://gitlab.com'),
            'specific_users' => explode(',', env('GITLAB_SPECIFIC_USERS')),
        ],
    ],
];

In app\Console\Kernel.php you should schedule the Creacoon\GitLabTile\FetchDataFromGitLabUserCountsCommand to run at your desired interval.

// in app/console/Kernel.php

protected function schedule(Schedule $schedule)
{
    // ...
    $schedule->command(\Creacoon\GitLabTile\FetchDataFromGitLabUserCountsCommand::class)->everyMinute();
}

Usage

In your dashboard view you use the livewire:gitlab-user-counts-tile component.

<x-dashboard>
    <livewire:gitlab-user-counts-tile position="a1" />
</x-dashboard>

Customizing the view

If you want to customize the view used to render this tile, run this command:

php artisan vendor:publish --provider="Creacoon\GitLabTile\GitLabUserCountsTileServiceProvider" --tag="dashboard-gitlab-user-counts-tile-views"```