Skip to content

MAIT-174: Add Pipedrive connector config templates#29

Open
acikabubo wants to merge 1 commit intomainfrom
MAIT-174-pipedrive-connector
Open

MAIT-174: Add Pipedrive connector config templates#29
acikabubo wants to merge 1 commit intomainfrom
MAIT-174-pipedrive-connector

Conversation

@acikabubo
Copy link
Copy Markdown
Contributor

Summary

  • Add Pipedrive source block to config.yaml.example with all supported options
  • Add PIPEDRIVE1/2 env vars to .env.rag.example

Test plan

  • Verify config.yaml.example renders valid YAML with docker compose config
  • Confirm env var names match those referenced in config.yaml.example

- Add Pipedrive source block to config.yaml.example
- Add PIPEDRIVE1/2 env vars to .env.rag.example
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 7, 2026

📝 Walkthrough

Summary by CodeRabbit

  • Chores
    • Added optional Pipedrive CRM integration configuration examples with API token and schedule parameters for multiple connector instances.

Walkthrough

The pull request extends two example configuration files with optional Pipedrive connector setup. The .env.rag.example file receives four new environment variable entries for Pipedrive API tokens and schedules, while config.yaml.example gains two commented-out Pipedrive source blocks with parameters for API authentication, object type loading, and scheduling.

Changes

Cohort / File(s) Summary
Pipedrive Configuration Examples
.env.rag.example, config.yaml.example
Added optional Pipedrive connector configuration entries. Environment file includes API token and schedule variables for two Pipedrive instances. Config file includes two Pipedrive source blocks with parameters for api_token, load_types, max_items, request_delay, max_retries, and schedules.
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: adding Pipedrive connector configuration templates to example files.
Description check ✅ Passed The description is directly related to the changeset, outlining the addition of Pipedrive configuration to example files and includes a clear test plan.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

🧹 Nitpick comments (1)
config.yaml.example (1)

77-80: Consider using environment variables for all optional parameters.

The optional parameters max_items, request_delay, and max_retries are currently hardcoded with example values (500, 1, and 3 respectively). While this provides clear examples, consider parameterizing them via environment variables (e.g., ${PIPEDRIVE1_MAX_ITEMS:-500}) for consistency and flexibility. This would allow users to customize these values without editing the config file.

♻️ Optional refactor to parameterize all optional settings

In config.yaml.example:

     #    max_items: 500            # optional, per-entity limit (default: unlimited)
     #    request_delay: 1          # seconds between API requests (default: 0)
     #    max_retries: 3            # retry attempts on failure (default: 3)
+    #    max_items: "${PIPEDRIVE1_MAX_ITEMS}"
+    #    request_delay: "${PIPEDRIVE1_REQUEST_DELAY}"
+    #    max_retries: "${PIPEDRIVE1_MAX_RETRIES}"

Then add corresponding entries in .env.rag.example:

 `#PIPEDRIVE1_API_TOKEN`=your-pipedrive-api-token
 `#PIPEDRIVE1_SCHEDULES`=3600
+#PIPEDRIVE1_MAX_ITEMS=500
+#PIPEDRIVE1_REQUEST_DELAY=1
+#PIPEDRIVE1_MAX_RETRIES=3
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@config.yaml.example` around lines 77 - 80, Replace the hardcoded example
values for max_items, request_delay, and max_retries with environment-variable
expansions so users can override them without editing the file; specifically
change the example entries for the keys max_items, request_delay, and
max_retries to use patterns like ${PIPEDRIVE1_MAX_ITEMS:-500},
${PIPEDRIVE1_REQUEST_DELAY:-1}, ${PIPEDRIVE1_MAX_RETRIES:-3} (keep the existing
schedules entry using ${PIPEDRIVE1_SCHEDULES}), and update the corresponding
.env example to document PIPEDRIVE1_MAX_ITEMS, PIPEDRIVE1_REQUEST_DELAY, and
PIPEDRIVE1_MAX_RETRIES with their default values.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@config.yaml.example`:
- Around line 77-80: Replace the hardcoded example values for max_items,
request_delay, and max_retries with environment-variable expansions so users can
override them without editing the file; specifically change the example entries
for the keys max_items, request_delay, and max_retries to use patterns like
${PIPEDRIVE1_MAX_ITEMS:-500}, ${PIPEDRIVE1_REQUEST_DELAY:-1},
${PIPEDRIVE1_MAX_RETRIES:-3} (keep the existing schedules entry using
${PIPEDRIVE1_SCHEDULES}), and update the corresponding .env example to document
PIPEDRIVE1_MAX_ITEMS, PIPEDRIVE1_REQUEST_DELAY, and PIPEDRIVE1_MAX_RETRIES with
their default values.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 89741378-e870-4c0b-ab8e-cdcc293565ef

📥 Commits

Reviewing files that changed from the base of the PR and between 08af470 and f05e2e9.

📒 Files selected for processing (2)
  • .env.rag.example
  • config.yaml.example

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.

1 participant