regen-announcements

In-app announcements for Fluidify Regen self-hosted instances.

Regen polls regen/announcements.json every 6 hours and displays active announcements as a dismissible banner to admin users. This repo is the single place to publish and retire them.

---

How it works

1. Regen instances fetch regen/announcements.json from this repo in the background every 6 hours
2. Any announcement in the file is shown as a banner to signed-in admins
3. Admins can dismiss a banner — it won't reappear unless the id changes
4. Announcements with a past expires_at date are automatically hidden

---

Publishing an announcement

1. Open regen/announcements.json on GitHub
2. Click the pencil (edit) icon
3. Add an entry to the announcements array (see schema below)
4. Click Propose changes → open a pull request → get it approved and merged
5. The announcement goes live within 6 hours on all instances

To unpublish: remove the entry and merge the change.

---

JSON schema

{
  "announcements": [
    {
      "id": "unique-slug",
      "type": "release",
      "title": "Short headline",
      "body": "One or two sentences of detail.",
      "cta_url": "https://github.com/FluidifyAI/Regen/releases/tag/v0.11.0",
      "cta_label": "See what's new",
      "expires_at": "2026-07-01T00:00:00Z"
    }
  ]
}

Fields

Field	Required	Description
id	Yes	Unique string. Changing it resets dismissals on all instances.
type	Yes	release, info, or pro_upsell. Controls banner colour.
title	Yes	Short headline shown in bold.
body	No	Supporting detail shown next to the title.
cta_url	No	URL for the call-to-action button.
cta_label	No	Button label. Defaults to "Learn more".
expires_at	No	ISO 8601 date. Banner is hidden after this date. Leave empty to show indefinitely.

Types

Type	Colour	Use for
release	Blue	New version announcements
info	Grey	General notices, maintenance windows
pro_upsell	Purple	Enterprise feature highlights

---

Example

{
  "announcements": [
    {
      "id": "v0.11.0-release",
      "type": "release",
      "title": "Regen v0.11.0 is out",
      "body": "In-app announcements, PostHog analytics opt-in, and more.",
      "cta_url": "https://github.com/FluidifyAI/Regen/releases/tag/v0.11.0",
      "cta_label": "See release notes",
      "expires_at": "2026-08-01T00:00:00Z"
    }
  ]
}

---

Branch protection

Direct pushes to main are blocked. All changes require a pull request with at least one approval. This prevents accidental announcements going live without review.