{"id":25176694,"url":"https://github.com/conduitio/conduit-connector-template","last_synced_at":"2025-05-06T23:20:47.218Z","repository":{"id":103039330,"uuid":"556802899","full_name":"ConduitIO/conduit-connector-template","owner":"ConduitIO","description":"A template for Conduit connectors","archived":false,"fork":false,"pushed_at":"2025-05-06T15:18:01.000Z","size":239,"stargazers_count":5,"open_issues_count":1,"forks_count":2,"subscribers_count":6,"default_branch":"main","last_synced_at":"2025-05-06T16:40:44.022Z","etag":null,"topics":["conduit","go","golang"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ConduitIO.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2022-10-24T14:41:47.000Z","updated_at":"2025-05-06T15:18:06.000Z","dependencies_parsed_at":"2024-02-12T13:28:40.806Z","dependency_job_id":"c8422f49-f54f-48e6-9be3-8b3e608cd373","html_url":"https://github.com/ConduitIO/conduit-connector-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ConduitIO%2Fconduit-connector-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ConduitIO%2Fconduit-connector-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ConduitIO%2Fconduit-connector-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ConduitIO%2Fconduit-connector-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ConduitIO","download_url":"https://codeload.github.com/ConduitIO/conduit-connector-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252783635,"owners_count":21803545,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["conduit","go","golang"],"created_at":"2025-02-09T13:17:54.610Z","updated_at":"2025-05-06T23:20:47.187Z","avatar_url":"https://github.com/ConduitIO.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Conduit Connector Template\n\nThis is a template project for building [Conduit](https://conduit.io) connectors\nin Go. It makes it possible to start working on a Conduit connector in a matter\nof seconds.\n\n## Quick start\n\n1. Click [_Use this template_](https://github.com/new?template_name=conduit-connector-template\u0026template_owner=ConduitIO) and clone your new repository.\n2. Initialize the repository using [`setup.sh`](https://github.com/ConduitIO/conduit-connector-template/blob/main/setup.sh) and commit your changes.\n   ```sh\n   ./setup.sh github.com/myusername/conduit-connector-myconnector\n   git add -A\n   git commit -m \"initialize repository\"\n   ```\n3. Fill out the `summary` and `description` in `connector.yaml`. Note that the\n   `source` and `destination` sections in this file shouldn't be changed, as\n   they are automatically generated from the source and destination configuration\n   structs.\n4. Set up [automatic Dependabot PR merges](#automatically-merging-dependabot-prs).\n\nWith that, you're all set up and ready to start working on your connector! As a\nnext step, we recommend that you check out\nthe [Conduit Connector SDK](https://github.com/ConduitIO/conduit-connector-sdk).\n\n## What's included?\n\n* Skeleton code for the connector's configuration, source and destination.\n* Example unit tests.\n* A [Makefile](/Makefile) with commonly used targets.\n* A [script](/scripts/bump_version.sh) that bumps the connector version.\n* A [script](/scripts/tag.sh) that tags the connector (which kicks of a\n  release).\n* A [GitHub workflow](/.github/workflows/test.yml) to build the code and run the tests.\n* A [GitHub workflow](/.github/workflows/lint.yml) to run a pre-configured set of linters.\n* A [GitHub workflow](/.github/workflows/release.yml) which automatically\n  creates a release when a tag is pushed.\n* A [Dependabot setup](/.github/dependabot.yml) which checks your dependencies\n  for available updates\n  and [merges minor version upgrades](/.github/workflows/dependabot-auto-merge-go.yml)\n  automatically.\n* [Issue](/.github/ISSUE_TEMPLATE) and [PR templates](/.github/pull_request_template.md).\n* A [README template](/README_TEMPLATE.md).\n\n## Automatically merging Dependabot PRs\n\n\u003e [!NOTE]\n\u003e This applies only to public connector repositories, as branch protection rules are not enforced in private repositories.\n\nThe template makes it simple to keep your connector up-to-date using automatic\nmerging of [Dependabot](https://github.com/dependabot) PRs. To make use of this\nsetup, you need to adjust some repository settings.\n\n1. Navigate to Settings -\u003e General and allow auto-merge of PRs.\n\n   ![Allow auto-merge](https://github.com/ConduitIO/conduit-connector-template/assets/8320753/695b15f0-85b4-49cb-966d-649e9bf03455)\n\n2. Navigate to Settings -\u003e Branches and add a branch protection rule.\n\n   ![Add branch protection rule](https://github.com/ConduitIO/conduit-connector-template/assets/8320753/9f5a07bc-d141-42b9-9918-e8d9cc648482)\n\n3. Create a rule for branch `main` that requires status checks `test` and\n   `golangci-lint`.\n\n   ![Status checks](https://github.com/ConduitIO/conduit-connector-template/assets/8320753/96219185-c329-432a-8623-9b4462015f32)\n\n## Recommended repository settings\n\n- Allow squash merging only.\n- Always suggest updating pull request branches.\n- Automatically delete head branches.\n- Branch protection rules on branch `main` (only in public repositories):\n  - Require a pull request before merging.\n  - Require approvals.\n  - Require status checks `build` and `golangci-lint`.\n  - Require branches to be up to date before merging.\n  - Require conversation resolution before merging.\n  - Do not allow bypassing the above settings.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconduitio%2Fconduit-connector-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fconduitio%2Fconduit-connector-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fconduitio%2Fconduit-connector-template/lists"}