Filament Deploy Indicator

Show the current application environment (ENV) and optional latest deployment info in your Filament topbar.

Features

• Shows current APP_ENV (mapped to a short label like PROD, STAGE, LOCAL) with a color-coded badge.
• Optional hint next to the label: commit hash, deploy time, git tag, or branch name.
• Click the badge to see full deployment info: commit, branch, author, message, tag, deploy time.
• Copy commit hash to clipboard with one click.
• Reads deployment metadata from a JSON file (default: storage/app/private/deploy-info.json).
• Can auto-generate the JSON from git on first request, or generate it during deployment via Artisan command.

Requirements

• PHP ^8.2
• Filament ^4.0 or ^5.0

Installation

composer require arnautdev/filament-deploy-indicator

Register the plugin

Add the plugin to your panel provider:

use Arnautdev\FilamentDeployIndicator\FilamentDeployIndicatorPlugin;

public function panel(Panel $panel): Panel
{
    return $panel
        ->plugins([
            FilamentDeployIndicatorPlugin::make(),
        ]);
}

Conditional visibility

Show the indicator only to specific users:

FilamentDeployIndicatorPlugin::make()
    ->visible(fn (): bool => auth()->user()?->is_admin === true),

Configuration

Publish the config file:

php artisan vendor:publish --tag="filament-deploy-indicator-config"

Main options

Option	Default	Description
position	GLOBAL_SEARCH_BEFORE	Filament render hook position
cache_ttl	30	Cache time in seconds
file_path	storage/app/private/deploy-info.json	Path to read deployment JSON from
write_path	storage/app/private/deploy-info.json	Path to write generated JSON to
auto_generate_when_missing	true	Generate JSON using git if file is missing
git_root	base_path()	Root of the git repository (env: DEPLOY_INDICATOR_GIT_ROOT)
env_map	See config	Mapping of environment → label + Filament color
topbar.show	'commit'	null, 'commit', 'deployed_at', 'tag', 'branch'
topbar.commit_length	7	Number of commit hash characters to show
topbar.date_format	'd.m H:i'	PHP date format for deployed_at hint

---

Generating deployment info

The plugin reads deployment metadata from a JSON file. There are two ways to generate it.

Option 1: During deployment (recommended)

Run the command as part of your deployment pipeline. Git data (commit, branch, author, message) is read automatically. This also gives accurate deployment timestamps.

php artisan deploy-indicator:write --env=production

Any option you pass overrides the git value. For example, to set a custom author:

php artisan deploy-indicator:write \
  --env=production \
  --author="CI Bot" \
  --deployed-at="$(date '+%Y-%m-%d %H:%M:%S')"

Option 2: Auto-generate on first request

Set auto_generate_when_missing = true in config (default). The JSON will be generated from git automatically on the first request if the file is missing. Useful for local development.

---

CI/CD integration examples

GitHub Actions

Git data is read automatically. Pass --commit-url to make the commit hash clickable in the dropdown.

- name: Write deploy info
  run: |
    php artisan deploy-indicator:write \
      --env=production \
      --commit-url="${{ github.server_url }}/${{ github.repository }}/commit/${{ github.sha }}"

GitLab CI

deploy:
  script:
    - |
      php artisan deploy-indicator:write \
        --env=production \
        --commit-url="$CI_PROJECT_URL/-/commit/$CI_COMMIT_SHA"

Shell / custom script

php artisan deploy-indicator:write --env=production

---

Verify your setup

Run the check command to see the current state of the plugin configuration:

php artisan deploy-indicator:check

Example output:

Filament Deploy Indicator — Setup Check

  ✓ Config file published
  ✓ Git repository detected at: /var/www/html
  ✓ Git info readable (commit: abc1234, branch: main)
  ✓ deploy-info.json found at: storage/app/private/deploy-info.json
  ✓ deploy-info.json is valid JSON
  ✓ Write path is writable: storage/app/private

Current deployment info:
 +--------------+-----------------------+
 | Key          | Value                 |
 +--------------+-----------------------+
 | environment  | production            |
 | deployed_at  | 2026-03-05 10:00:00   |
 | commit       | abc1234...            |
 | branch       | main                  |
 | author       | Dmitry                |
 +--------------+-----------------------+

---

Deployment JSON format

The plugin reads a JSON file with this structure:

{
  "environment": "production",
  "deployed_at": "2026-03-04 16:30:00",
  "commit": "33de817f4b2c3a1e9d0f8c7b5e2a4d6f8b1c3e5a",
  "branch": "main",
  "author": "Dmitry",
  "commit_message": "initial release",
  "commit_url": "https://github.com/your/repo/commit/33de817",
  "tag": "v1.0.0"
}

All fields are optional. Default location: storage/app/private/deploy-info.json.

---

Testing

composer test

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

• Dmitry Arnaut
• All Contributors

License

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