Skip to content

feat(skill): add substreams-sink-deploy skill#5

Merged
GabrielCartier merged 17 commits into
developfrom
feature/sink-skill
Apr 30, 2026
Merged

feat(skill): add substreams-sink-deploy skill#5
GabrielCartier merged 17 commits into
developfrom
feature/sink-skill

Conversation

@GabrielCartier
Copy link
Copy Markdown
Contributor

@GabrielCartier GabrielCartier commented Apr 29, 2026

Summary

  • New substreams-sink-deploy skill for running and deploying Substreams sinks to SQL databases
  • Covers CLI arg order, DSN scheme requirements (psql:// not postgresql://), and discoverability
  • 4 iterative fixes applied from T7.1 trial findings

Test plan

  • Verify skills/substreams-sink-deploy/SKILL.md loads correctly in Claude Code
  • Run sink deploy task end-to-end against a local PostgreSQL instance
  • Confirm DSN scheme psql:// accepted by substreams-sink-sql v4.13.1

🤖 Generated with Claude Code

GabrielCartier and others added 4 commits April 29, 2026 12:25
End-to-end guide for getting Substreams data into a destination:
- Decision tree: SQL / Files / PubSub / Webhook / Subgraph / SDK
- Build-side vs run-side architecture
- Per-sink: install, required output proto, run command, cursor mgmt
- Hosted vs self-hosted decision matrix
- Production patterns: backfill+live, monitoring, reorg safety
- Common pitfalls: wrong proto type, missing cursor tables, etc.

Complements existing skills:
- substreams-dev: builds modules
- substreams-sql: db_out / DatabaseChanges build patterns
- substreams-sink: SDK consumption (Go/JS/Rust)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
From T7.1 trial findings:
- Tighten description with explicit triggers (run/deploy/operate verbs)
- Add explicit boundary vs substreams-sql skill (build vs run)
- Pitfall 6: --batch-block-flush-interval default 1000 too big for <1000 block ranges
- Pitfall 7: composite vs single PK wire format mismatch in db_out
- Pitfall 8: --on-module-hash-mismatch flag for cursor reuse after .spkg changes
- Clarify SUBSTREAMS_API_KEY (not _TOKEN) is the right env var

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
From T7.1 trial #3 finding:
- substreams-sink-sql run signature is: <dsn> <manifest> [<range>] -e <endpoint>
- Endpoint is -e/--endpoint flag, NOT positional
- Module name positional but optional (auto-inferred from .spkg)
- Fixed all 4 example commands in skill body
… postgresql://

T7.1 trial 4 finding: substreams-sink-sql v4.13.1 rejects postgresql:// DSN
scheme. Accepts: psql, postgres, clickhouse, parquet. Update both DSN
examples in skill to use psql:// and add the full accepted-schemes list.
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds a new skill document (substreams-sink-deploy) to guide users through running and deploying Substreams sink binaries (SQL/files/PubSub/webhook/protojson/subgraph), focusing on operational setup details like DSNs, CLI argument order, cursor/reorg handling, and common pitfalls.

Changes:

  • Introduces a new substreams-sink-deploy skill with decision tree + end-to-end operational workflows.
  • Documents SQL sink DSN scheme requirements and common runtime pitfalls (schema, cursors, reorgs, batching).
  • Provides runnable command examples for multiple sink types plus a quick-reference “full example”.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread skills/substreams-sink-deploy/SKILL.md
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 5 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread skills/substreams-sink-deploy/SKILL.md
Comment thread skills/substreams-sink-deploy/SKILL.md
Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Comment thread skills/substreams-sink-deploy/SKILL.md
Comment thread skills/substreams-sink-deploy/SKILL.md
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Comment thread skills/substreams-sink-deploy/SKILL.md
Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 5 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Comment thread skills/substreams-sink-deploy/SKILL.md
Comment thread skills/substreams-sink-deploy/SKILL.md
Comment thread skills/substreams-sink-deploy/SKILL.md
Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
…kg consistency, webhook state.json path, sales email

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@GabrielCartier GabrielCartier requested a review from Copilot April 30, 2026 07:36
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated 4 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread skills/substreams-sink-deploy/SKILL.md
Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Comment thread skills/substreams-sink-deploy/SKILL.md
Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
GabrielCartier and others added 2 commits April 30, 2026 14:41
…leased

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
… fix module-hash-mismatch flag docs

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

Comments suppressed due to low confidence (1)

README.md:123

  • The Plugin Structure tree was updated to include substreams-sink-deploy/, but it still omits the existing skills/substreams-sink/ directory. Since users rely on this tree to discover available skills, please add substreams-sink/ here for completeness/accuracy.
└── skills/
    ├── substreams-dev/
    │   ├── SKILL.md          # Main skill content
    │   └── references/       # Additional reference materials
    │       ├── manifest-spec.md
    │       ├── module-types.md
    │       ├── networks.md
    │       └── patterns.md
    ├── substreams-sink-deploy/
    │   └── SKILL.md
    ├── substreams-sql/
    │   ├── SKILL.md
    │   └── references/
    │       ├── clickhouse-patterns.md
    │       └── database-changes.md
    └── substreams-testing/

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
Comment thread skills/substreams-sink-deploy/SKILL.md Outdated
…tup, not required in schema.sql

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md Outdated
Comment thread README.md
…d substreams-sink to structure tree

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread skills/substreams-sink-deploy/SKILL.md
…client, fix stale cursors comment

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
…ll to Available Skills section

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@GabrielCartier GabrielCartier merged commit a866ec3 into develop Apr 30, 2026
5 checks passed
@GabrielCartier GabrielCartier deleted the feature/sink-skill branch April 30, 2026 08:22
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.

2 participants