feat: news-plugin #1248

ileana-pr · 2024-12-19T20:30:07Z

Relates to:

AI Agent Dev School Video #2: https://www.youtube.com/watch?v=XenGeAcPAQo&t=3383s

Risks

Low

Background

Shaw shows us how to create a simple plugin that returns the latest news on a specific topic. This is an example code of a completed currentNewsAction. It can be modified and expanded for added functionality.

What does this PR do?

Adds an example of the news plugin described by Shaw.

What kind of change is this?

Features

It will help future students to see an example of the code and more experienced devs to add functionality to a useful plugin.

Documentation changes needed?

none, but I can add documentation

Testing

I tested the plugin with C3PO character and was able to retrieve news on different topics.

Formatting of the output can use some improvement.

Where should a reviewer start?

news.ts

Detailed testing steps

ileana-pr · 2025-01-02T00:35:26Z

@odilitime @shakkernerd added README.md documentation, updated output format & tested.

ileana-pr · 2025-01-11T03:59:57Z

gm @odilitime @shakkernerd , anything I can fix or do to help get this plugin merged? thanks.

tcm390

LGTM. Just some small change requests

tcm390 · 2025-01-11T04:03:34Z

agent/src/index.ts

 import { zgPlugin } from "@ai16z/plugin-0g";
 import { bootstrapPlugin } from "@ai16z/plugin-bootstrap";
 import createGoatPlugin from "@ai16z/plugin-goat";
-// import { intifacePlugin } from "@ai16z/plugin-intiface";
+import { intifacePlugin } from "@ai16z/plugin-intiface";


Do we need this? 👀

tcm390 · 2025-01-11T04:06:27Z

packages/plugin-news/src/actions/news.ts

+    name: "CURRENT_NEWS",
+    similes: ["NEWS", "GET_NEWS", "GET_CURRENT_NEWS"],
+    validate: async (_runtime: IAgentRuntime, _message: Memory) => {
+        return true;


Could validate NEWS_API_KEY here:

e.g. return runtime.getSetting("NEWS_API_KEY")

tcm390 · 2025-01-11T04:13:25Z

agent/src/index.ts

@@ -482,6 +483,7 @@ export async function createAgent(
        // character.plugins are handled when clients are added
        plugins: [
            bootstrapPlugin,
+            newsPlugin,


Hello! Would you mind removing it from the default plugin configuration? If people need it, they can add it themselves. Also, we should only add the plugin if the environment variable is set. 😊

@tcm390 all done and ready for review. thank you.

shakkernerd · 2025-01-23T21:46:40Z

@ileana-pr kindly resolve the conflicts on this.

coderabbitai · 2025-01-24T17:53:25Z

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.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@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.

ileana-pr · 2025-01-24T18:01:42Z

@shakkernerd conflicts resolved. Thanks much.

ileana-pr changed the title ~~feature: news-plugin~~ feat: news-plugin Dec 19, 2024

odilitime changed the base branch from main to develop December 20, 2024 04:25

odilitime added Needs Testing Plugin_new Mark PRs that are a new plugin needs_documentation labels Dec 20, 2024

shakkernerd deleted the branch elizaOS:develop December 22, 2024 07:02

shakkernerd closed this Dec 22, 2024

odilitime reopened this Dec 22, 2024

tcm390 requested changes Jan 11, 2025

View reviewed changes

ileana-pr force-pushed the news-plugin branch from 3e479be to 9a9d0ff Compare January 12, 2025 16:41

ileana-pr added 4 commits January 12, 2025 13:17

news-plugin

cb587b4

chore: added description to NEWS API KEY label

079ce1a

add README.md documentation

ddc8dea

updated & tested plugin

be682b5

ileana-pr force-pushed the news-plugin branch from 9a9d0ff to be682b5 Compare January 12, 2025 18:24

ileana-pr added 2 commits January 12, 2025 20:35

updates

f798211

fixed nft-collections line

3559a1f

Merge remote-tracking branch 'upstream/develop' into news-plugin

deed309

ileana-pr and others added 2 commits January 24, 2025 20:48

Merge remote-tracking branch 'upstream/develop' into news-plugin

7f0a587

Merge branch 'develop' into news-plugin

027f951

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: news-plugin #1248

feat: news-plugin #1248

ileana-pr commented Dec 19, 2024

ileana-pr commented Jan 2, 2025

ileana-pr commented Jan 11, 2025

tcm390 left a comment

tcm390 Jan 11, 2025 •

edited

Loading

tcm390 Jan 11, 2025

tcm390 Jan 11, 2025

ileana-pr Jan 13, 2025

shakkernerd commented Jan 23, 2025

coderabbitai bot commented Jan 24, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

ileana-pr commented Jan 24, 2025

feat: news-plugin #1248

Are you sure you want to change the base?

feat: news-plugin #1248

Conversation

ileana-pr commented Dec 19, 2024

Relates to:

Risks

Background

What does this PR do?

What kind of change is this?

Documentation changes needed?

Testing

Where should a reviewer start?

Detailed testing steps

ileana-pr commented Jan 2, 2025

ileana-pr commented Jan 11, 2025

tcm390 left a comment

Choose a reason for hiding this comment

tcm390 Jan 11, 2025 • edited Loading

Choose a reason for hiding this comment

tcm390 Jan 11, 2025

Choose a reason for hiding this comment

tcm390 Jan 11, 2025

Choose a reason for hiding this comment

ileana-pr Jan 13, 2025

Choose a reason for hiding this comment

shakkernerd commented Jan 23, 2025

coderabbitai bot commented Jan 24, 2025

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

ileana-pr commented Jan 24, 2025

tcm390 Jan 11, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)