everyday/craft-incremental-static-regeneration

A plugin that watches your entry changes and pings a URL of your choice

1.3.2 2024-12-04 22:01 UTC

Requires

• craftcms/cms: ^5.0

Requires (Dev)

• vlucas/phpdotenv: ^3.0

proprietary

• Everyday AS

• static
• incremental
• nextjs
• regeneration

README

This plugin is best used with a front-end framework that supports Incremental Static Regeneration, like Next.js.

The whole purpose of this plugin is to hit an API in your front-end, with the URI and siteHandle of the entry being updated, in order to trigger a rebuild of the front-end page.

Installation

composer require everyday/craft-incremental-static-regeneration

Features

• Regenerate all pages when a global is updated.
• Regenerate all entries that use a specific asset when an asset is updated.
• Bypass ISR in preview mode.
• Exclude specific globals or sections from sending a request to your front-end's API.
• Allows adding custom triggers to accommodate any other use cases you may have.

Usage

Check out the wiki :)

Local development

You probably don't need this, so we've collapsed this section.

Installing the Composer dependencies:

docker run --rm \
    -u "$(id -u):$(id -g)" \
    -v $(pwd):/opt \
    -w /opt \
    craftcms/cli:8.1-dev \
    composer install --ignore-platform-reqs