Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add spin kinesis trigger plugin info #1390

Merged
merged 2 commits into from
Oct 7, 2024
Merged

Conversation

ogghead
Copy link
Contributor

@ogghead ogghead commented Oct 4, 2024

Content must go through a pre-merge checklist.

Pre-Merge Content Checklist

This documentation has been checked to ensure that:

  • The title, template, and date are all set
  • Does this PR have a new menu item (anywhere in templates/*.hbs files) that points to a document .md that is set to publish in the future? If so please only publish the .md and .hbs changes in real-time (otherwise there will be a menu item pointing to a .md file that does not exist)
    • No new menu item
  • File does not use CRLF, but uses plain LF (hint: use cat -ve <filename> | grep $'\r' | wc -l and expect 0 as a result)
  • Has passed bart check
    • Ran: bart check content/api/hub/plugin_spin_kinesis_trigger.md
    • Output: ✅ content/api/hub/plugin_spin_kinesis_trigger.md
  • Has been manually tested by running in Spin/Bartholomew (hint: use PREVIEW_MODE=1 and run npm run styles to update styling)
  • Headings are using Title Case
  • Code blocks have the programming language set to properly highlight syntax and the proper copy directive
  • Have tested with npm run test and resolved all errors
    • All the errors were transient. The links are valid!
  • Relates to an existing (potentially outdated) blog article? If so please add URL in blog to point to this content.
    • Blog has not yet been published, but I will add a link soon!

Signed-off-by: Darwin Boersma <darwin@sadlark.com>
Copy link
Contributor

@karthik2804 karthik2804 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Just a couple of suggestions.

You can install the plugin using the following command:

```sh
spin plugins install --url https://github.com/ogghead/spin-trigger-kinesis/releases/download/canary/trigger-kinesis.json
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this has now been added to the registry, we can install via

spin plugins install trigger-kinesis

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point! I listed the canary because (currently) it includes features that aren't in a tagged version, and I saw a lot of trigger plugins on Spin hub doing the same (e.g. https://developer.fermyon.com/hub/preview/plugin_sqs_trigger). My hope is to swap this once the plugin is not under active feature development (planning 0.4 to be a longer term stable release), but happy to swap it now if that's preferred. Let me know your thoughts!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do not really have a strong preference but I think the case with other plugins in the hub might be half of them are not published to the spin plugin registry.

content/api/hub/plugin_spin_kinesis_trigger.md Outdated Show resolved Hide resolved
Co-authored-by: Karthik Ganeshram <karthik.ganeshram@fermyon.com>
Signed-off-by: Darwin Boersma <darwin.boersma@gmail.com>
@karthik2804
Copy link
Contributor

I will merge this once CI passes. Thanks for this @ogghead

@macolso macolso merged commit bc8c613 into fermyon:main Oct 7, 2024
3 checks passed
@ogghead ogghead deleted the spin_kinesis branch October 7, 2024 19:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants