Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Bug report
about: Report a bug in this plugin
title: '[Bug] '
labels: bug
assignees: ''
---

## Describe the bug

A clear and concise description of what the bug is.

## To reproduce

Steps to reproduce the behavior:
1. Config used (redact any secrets)
2. Command run
3. Error output

## Expected behavior

What you expected to happen.

## Environment

- workflow engine version: <!-- e.g. 0.3.51 -->
- plugin version: <!-- e.g. 1.0.0 -->
- Go version: <!-- go version -->
- OS: <!-- e.g. linux/amd64, darwin/arm64 -->

## Additional context

Add any other context or logs here.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
name: Feature request
about: Suggest a new capability for this plugin
title: '[Feature] '
labels: enhancement
assignees: ''
---

## Summary

A one-sentence description of the feature.

## Motivation

Why is this feature needed? What problem does it solve?

## Proposed solution

How would you like it to work? Include config schema changes if relevant.

## Alternatives considered

Any alternative approaches you considered and why you ruled them out.

## Additional context

Links, screenshots, or related issues.
20 changes: 20 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
## Summary

<!-- What does this PR do? 1-3 bullet points. -->

## Motivation

<!-- Why is this change needed? Link to issue if applicable. Closes #NNN -->

## Test plan

- [ ] `go build ./...` passes
- [ ] `go vet ./...` passes
- [ ] `go test ./...` passes
- [ ] Manual smoke test (describe)

## Checklist

- [ ] CHANGELOG.md updated (Keep-a-Changelog format)
- [ ] No secrets or credentials included
- [ ] One feature or bugfix per PR
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# Changelog

## [Unreleased]

### Added
- Verified banner in README — plugin confirmed used in production at buymywishlist.
- CONTRIBUTING.md with local dev instructions and PR checklist.
- `examples/minimal/config.yaml` — runnable `step.eventbus.publish` example using pgchannel provider without an external broker.

## v0.3.4 — 2026-05-13

### Fixed
Expand Down
27 changes: 27 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Contributing to workflow-plugin-eventbus

This plugin is part of the [GoCodeAlone/workflow](https://github.com/GoCodeAlone/workflow) ecosystem.

## Before contributing

Read the [upstream CONTRIBUTING.md](https://github.com/GoCodeAlone/workflow/blob/main/CONTRIBUTING.md) for general conventions, signing, and review expectations.

## Local development

```sh
git clone https://github.com/GoCodeAlone/workflow-plugin-eventbus.git
cd workflow-plugin-eventbus
go build ./...
go test ./...
```

## Pull requests

- One feature or bugfix per PR.
- Update CHANGELOG.md with a Keep-a-Changelog entry.
- Add tests covering new behavior.
- Run `go vet ./...` before pushing.

## Reporting issues

See the issue templates under `.github/ISSUE_TEMPLATE/`.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# workflow-plugin-eventbus

> ✅ **Verified** — used in production at **buymywishlist**. This plugin has been validated end-to-end in a merged main-branch wfctl.yaml of an active GoCodeAlone project.

A [workflow](https://github.com/GoCodeAlone/workflow) external plugin that provisions durable event-bus clusters and exposes typed pipeline steps for publish/consume operations.

> **v0.2.0 module-type rename:** `infra.eventbus*` → `eventbus.*`. The `infra.` prefix is reserved for IaC modules; eventbus modules are runtime modules. If you're upgrading from v0.1.0, see [MIGRATION.md](MIGRATION.md).
Expand Down
25 changes: 25 additions & 0 deletions examples/minimal/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# examples/minimal/config.yaml — minimal workflow-plugin-eventbus example.
# Demonstrates publishing an event via step.eventbus.publish.
# Uses pgchannel provider which requires only a DATABASE_URL — no external broker needed.

modules:
- name: my-events
type: eventbus.broker
config:
provider: pgchannel
broker_target: in_process
dsn: '{{config "database_url"}}'

pipelines:
publish-example:
trigger:
type: http
config:
path: /events/publish
method: POST
steps:
- name: publish
type: step.eventbus.publish
config:
subject: events.created
payload: '{{toJson .body}}'
Loading