craftyhedge/craft-bump

Writes a timestamp to a file when Craft CMS events fire.

Maintainers

Package info

github.com/craftyhedge/craft-bump

Documentation

Type:craft-plugin

pkg:composer/craftyhedge/craft-bump

Statistics

Installs: 0

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

v1.0.0 2026-02-08 03:09 UTC

This package is auto-updated.

Last update: 2026-06-10 03:55:42 UTC


README

Supports Craft 4.4+ and Craft 5.x

What does it do?

It writes a timestamp to a file when your chosen events fire.

What is it useful for?

Good question!

Original Use Case: Vite Browser Reloading

If you are a Vite user, you can use vite-plugin-restart and configure it to watch the bump file.

Set the Entry Saved event to trigger a bump, and add the bump file to your Vite config:

ViteRestart({
    reload: [
        // your other watched files...
        // path to bump file
        'storage/runtime/bump.txt',
    ],
}),

Now when you save an entry in Craft, your Vite dev server will trigger a hot reload!

Installation

From the Plugin Store

Go to the Plugin Store in your Craft control panel, search for Bump, and click Install.

With Composer

composer require craftyhedge/craft-bump
php craft plugin/install bump

Configuration

Go to Settings → Plugins → Bump in the Craft control panel.

File Path

Path where the timestamp file will be written. Supports Craft aliases:

  • @storage/runtime/bump.txt (default) — within the runtime directory
  • @storage/bump.txt — within the storage directory
  • @root/bump.txt — project root

Allowed Environments

Comma-separated list of environment names where bumping is active. Use * to allow all environments.

Examples:

  • dev (only local development)
  • dev,staging (only these environments)
  • * (all environments)

Timestamp Format

Choose a PHP date() format from the available options:

  • U (default) — Unix epoch (e.g., 1770422400)
  • c — ISO 8601 (e.g., 2026-02-07T12:30:00+00:00)
  • Y-m-d H:i:s — Datetime (e.g., 2026-02-07 12:30:00)
  • Y-m-d — Date only (e.g., 2026-02-07)
  • Ymd.His — Compact (e.g., 20260207.123000)

Events

Toggle which CMS events trigger a file update:

Event Description
Entry Saved Any entry is created or updated
Entry Deleted Any entry is deleted
Asset Saved Any asset is uploaded or updated
Asset Deleted Any asset is deleted
Category Saved Any category is created or updated
Category Deleted Any category is deleted
Global Set Saved Any global set is updated
User Saved Any user is created or updated
User Deleted Any user is deleted

License

MIT — see LICENSE.md.