Eli2 107/fix plugin publishing #4095

yungalgo · 2025-03-27T22:01:53Z

PR: Enhance ElizaOS Plugin Development and Publishing Workflow

This PR improves the complete plugin lifecycle - from creation to development to publishing - with a focus on streamlining the developer experience and ensuring plugins work correctly within the ElizaOS ecosystem.

Key Improvements

Proper Plugin Naming:
- Modified template generation to dynamically replace the hardcoded plugin name in source files with the actual plugin name
- Ensures plugins use the correct name at runtime in dev/start mode
Registry Publishing Requirements:
- Added missing required components to plugin templates:
- Added images/ directory with detailed README
- Added agentConfig section to package.json
- Properly formatted repository URL with placeholders
Plugin Template Enhancements:
- Updated success message in create.ts with clearer next steps
- Improved plugin README.md with more detailed guidance
- Added proper configuration schema validation
Developer Experience Improvements:
- Preserved custom changes to template files during builds
- Fixed repository URL format to use the correct GitHub pattern
- Enhanced plugin startup and error logging
Plugin Publishing Workflow:
- Implemented validation for plugin requirements before publishing
- Improved the GitHub PR flow for registry submissions
- Added clearer feedback messages during the publishing process
- Added guided inputs for plugin description and other metadata

Plugin Publishing Validation

The plugin publishing validation (npx elizaos plugin publish --test) now checks against the ElizaOS registry PR template requirements:

Verification of public GitHub repository accessibility
Validation of 'main' as the default branch
Checking for the 'elizaos-plugins' topic in repository settings
Repository description presence
Directory structure validation:
- Presence of images/ directory with logo.jpg and banner.jpg
- Proper image file sizes and formats
- Source code structure (src/index.ts, etc.)
Package.json validation:
- Proper agentConfig section
- Correct repository URL format
- Required plugin parameters

Testing Performed

Plugin Creation:
- Verified template files contain all required components
- Confirmed that the correct package name is used in all places
- Validated directory structure is correct, including images folder
Plugin Development:
- Tested the dev command with hot-reloading
- Confirmed plugin actions are registered and triggered correctly
- Verified log output shows the correct plugin name
Plugin Startup:
- Tested the start command for launching plugins
- Validated service initialization sequence
- Confirmed plugin loads with the correct name
Plugin Publishing:
- Tested the plugin publish --test validation workflow
- Verified repository URL formatting and template replacement
- Confirmed PR creation flow to the registry repo
- Validated proper forking of the registry repository

UX Improvements

Added clearer step-by-step guidance during the plugin publishing process
Added prompts to create required assets like logo and banner
Improved error messaging to help developers fix issues
Enhanced console output with visual formatting and emojis
Added dynamic input for plugin descriptions and GitHub username

Commands Tested (in order)

npx elizaos create -t plugin [name/plugin-name]
cd plugin-name
npx elizaos dev
npx elizaos start
npx elizaos test (not worked on, tests not written or passing)
npx elizaos plugin publish --test
npx elizaos plugin publish

Future Work Needed

Registry Integration: I am not positive if the new plugin is being registered correctly in the registry fork / PR step, this needs a sanity check and guidance.
Testing Framework: The plugin test command still needs implementation

create plugin command + publish plugin --test works. still need to test dev, start, and publish (actual) no github repo functionality

now the repo pushes and the registry is updated and a pr is made, all in the cli, there is validation for plugin reqs too.

coderabbitai · 2025-03-27T22:03:08Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

odilitime · 2025-03-29T00:37:00Z

packages/plugin-starter/package.json

@@ -9,7 +9,7 @@
  "types": "dist/index.d.ts",
  "repository": {
    "type": "git",
-    "url": "https://github.com/elizaos-plugins/plugin-starter"
+    "url": "github:{{GITHUB_USERNAME}}/{{PLUGIN_NAME}}"


I wonder if this will cause problems with Lerna

i reverted it to previous state, let's not change this for now i agree.

odilitime · 2025-03-30T03:39:04Z

packages/cli/src/utils/plugin-publisher.ts

@@ -273,7 +273,7 @@ export async function publishToGitHub(
  }

  // Create version branch - use type in branch name
-  const entityType = packageJson.type || 'plugin';


any idea what other types they were thinking about?

it could also be a project -- i also added a quick error message if type != plugin.

odilitime · 2025-03-30T03:41:52Z

packages/cli/src/utils/github.ts

+
+      // Try force pushing if normal push fails
+      try {
+        logger.info('Attempting force push...');


this could be dangerous, what's the case where we need to go this far.

let me see if i can get it accomplished in a less aggressive manner

packages/cli/src/utils/github.ts

odilitime · 2025-03-30T03:58:08Z

packages/cli/src/commands/create.ts

+          // Update targetDir to use the prefixed name
+          targetDir = path.join(options.dir === '.' ? process.cwd() : options.dir, projectName);
+        }
+


why not just const and calculate the targetDir name here

yes, i refactored this, thank you

odilitime · 2025-03-30T04:06:23Z

packages/cli/src/commands/plugin.ts

+  const packageJson = JSON.parse(await fs.readFile(packageJsonPath, 'utf-8'));
+
+  return {
+    name: packageJson.name.includes('plugin-'),


we may want @elizaos/ prefix too but not sure

yungalgo added 3 commits March 27, 2025 13:18

plugin publishing, pt 1

049d857

create plugin command + publish plugin --test works. still need to test dev, start, and publish (actual) no github repo functionality

fixing plugin publishing

75cf4d7

now the repo pushes and the registry is updated and a pr is made, all in the cli, there is validation for plugin reqs too.

give correct plugin name in dev/start mode

51f7594

yungalgo added the V2 Eliza 1.x label Mar 27, 2025

minor metadata fixes in index.json and packages/plugin-name.json

fcb2c8f

odilitime reviewed Mar 29, 2025

View reviewed changes

Merge branch 'v2-develop' into ELI2-107/fix-plugin-publishing

fca6790

odilitime reviewed Mar 30, 2025

View reviewed changes

packages/cli/src/utils/github.ts Show resolved Hide resolved

odilitime reviewed Mar 30, 2025

View reviewed changes

odilitime approved these changes Mar 30, 2025

View reviewed changes

lalalune merged commit a6b7cb8 into v2-develop Apr 1, 2025
1 of 3 checks passed

lalalune deleted the ELI2-107/fix-plugin-publishing branch April 1, 2025 14:58

yungalgo mentioned this pull request Apr 1, 2025

Chore/plugin publishing fixes #4132

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Eli2 107/fix plugin publishing #4095

Eli2 107/fix plugin publishing #4095

yungalgo commented Mar 27, 2025

coderabbitai bot commented Mar 27, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

odilitime Mar 29, 2025

yungalgo Apr 1, 2025

odilitime Mar 30, 2025

yungalgo Apr 1, 2025

odilitime Mar 30, 2025

yungalgo Apr 1, 2025

odilitime Mar 30, 2025

yungalgo Apr 1, 2025

odilitime Mar 30, 2025

Eli2 107/fix plugin publishing #4095

Eli2 107/fix plugin publishing #4095

Conversation

yungalgo commented Mar 27, 2025

PR: Enhance ElizaOS Plugin Development and Publishing Workflow

Key Improvements

Plugin Publishing Validation

Testing Performed

UX Improvements

Commands Tested (in order)

Future Work Needed

coderabbitai bot commented Mar 27, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

CodeRabbit Configuration File (`.coderabbit.yaml`)