Skip to content

gennit-project/multiforum-plugin-hello-world

Repository files navigation

Hello World Plugin

The Hello World plugin demonstrates the Multiforum plugin lifecycle at the channel scope. When a file-enabled channel activates the plugin it will log a message and write a lightweight info flag every time downloadable content is created or updated.

Capabilities

  • Runs whenever a downloadableFile.created or downloadableFile.updated event fires for the channel.
  • Calls the host-provided ctx.storeFlag() helper so moderators can see when the hook executed.
  • Requires no configuration or secrets.

Settings Form

Because this is a sample plugin there are no settings to configure. The plugin manifest still ships a form schema (see plugin.json) that renders a short description so administrators can preview how manifest-driven forms appear in the Multiforum UI.

Standalone Plugin Package

This repository is the source of truth for hello-world. Plugin releases are versioned with Git tags in the form v<plugin.json version>.

Development

npm install
npm run ci

npm run ci validates plugin.json, runs Vitest, builds TypeScript, and creates a release bundle under out/.

Release

  1. Update plugin.json and package.json to the same version.
  2. Commit the change.
  3. Tag the commit with v<version>.
  4. Push the tag.

The Publish Release workflow builds hello-world-<version>.tgz, writes a SHA-256 checksum, and uploads both artifacts to the GitHub Release.

Registry Metadata

Use this source URL in the Multiforum plugin registry:

{
  "sourceRepoUrl": "https://github.com/gennit-project/multiforum-plugin-hello-world",
  "releaseNotesUrl": "https://github.com/gennit-project/multiforum-plugin-hello-world/releases/tag/v0.2.2"
}

About

Official Multiforum hello world example plugin

Resources

Stars

0 stars

Watchers

0 watching

Forks

Packages

 
 
 

Contributors