https://github.com/conduitio/conduit-processor-template
A template for Conduit processors
https://github.com/conduitio/conduit-processor-template
conduit go golang processor
Last synced: about 2 months ago
JSON representation
A template for Conduit processors
- Host: GitHub
- URL: https://github.com/conduitio/conduit-processor-template
- Owner: ConduitIO
- License: apache-2.0
- Created: 2024-10-15T22:05:58.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-04-01T17:06:46.000Z (2 months ago)
- Last Synced: 2025-04-01T17:45:45.801Z (2 months ago)
- Topics: conduit, go, golang, processor
- Language: Go
- Size: 455 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Conduit Processor Template
This is a template project for building [Conduit](https://conduit.io) processors in Go. It makes it possible to
start working on a Conduit processor in a matter of seconds.
> [!TIP]
> Are you looking to write a simple processor for your specific use case? In that case you could take the simpler
> approach - check out the
> [documentation](https://conduit.io/docs/developing/processors/building#using-sdknewprocesorfunc) how you
> can write a processor in a single function!
## Quick start
1. Click [_Use this template_](https://github.com/new?template_name=conduit-processor-template&template_owner=ConduitIO) and clone your new repository.
2. Initialize the repository using [`setup.sh`](https://github.com/ConduitIO/conduit-processor-template/blob/main/setup.sh) and commit your changes.
```sh
./setup.sh github.com/myusername/conduit-processor-myprocessor
git add -A
git commit -m "initialize repository"
```
3. Set up [automatic Dependabot PR merges](#automatically-merging-dependabot-prs).
With that, you're all set up and ready to start working on your processor! As a next step, we recommend that you
check out the [Conduit Processor SDK](https://github.com/ConduitIO/conduit-processor-sdk).
## What's included?
* Skeleton code for the processor and its configuration.
* Example unit tests.
* A [Makefile](/Makefile) with commonly used targets.
* A [GitHub workflow](/.github/workflows/test.yml) to build the code and run the tests.
* A [GitHub workflow](/.github/workflows/lint.yml) to run a pre-configured set of linters.
* A [GitHub workflow](/.github/workflows/release.yml) which automatically creates a release when a tag is pushed.
* A [Dependabot setup](/.github/dependabot.yml) which checks your dependencies for available updates and
[merges minor version upgrades](/.github/workflows/dependabot-auto-merge-go.yml) automatically.
* [Issue](/.github/ISSUE_TEMPLATE) and [PR templates](/.github/pull_request_template.md).
* A [README template](/README_TEMPLATE.md).
## Automatically merging Dependabot PRs
> [!NOTE]
> This applies only to public processor repositories, as branch protection rules are not enforced in private repositories.
The template makes it simple to keep your processor up-to-date using automatic merging of
[Dependabot](https://github.com/dependabot) PRs. To make use of this setup, you need to adjust
some repository settings.
1. Navigate to Settings -> General and allow auto-merge of PRs.
2. Navigate to Settings -> Branches and add a branch protection rule.
3. Create a rule for branch `main` that requires status checks `build` and `golangci-lint`.
## Recommended repository settings
- Allow squash merging only.
- Always suggest updating pull request branches.
- Automatically delete head branches.
- Branch protection rules on branch `main` (only in public repositories):
- Require a pull request before merging.
- Require approvals.
- Require status checks `build` and `golangci-lint`.
- Require branches to be up to date before merging.
- Require conversation resolution before merging.
- Do not allow bypassing the above settings.