mirror of
https://github.com/temporalio/skill-temporal-developer.git
synced 2026-09-14 13:52:58 +08:00
Add integrations catalog + per-language integrations/ layout (#151)
* Add integrations catalog and per-language integrations/ layout
Adds references/integrations.md as a single catalog table for third-party
plugins and integrations (one row per integration: language, what it does,
link to a reference file). Reference files live under
references/{language}/integrations/.
Pre-seeds the catalog by moving the existing Spring Boot reference into
the new layout (references/java/integrations/spring-boot.md) and updating
its inbound links.
SKILL.md gains a single 3-line "Third-Party Integrations" section pointing
at the catalog so SKILL.md no longer accrues a line per new integration.
Each language entry-point (java.md, python.md) gets a one-line pointer to
the catalog filtered to its language.
This lets open integration PRs (Spring AI, Google ADK, OpenAI Agents
sandbox) be rebased onto a consistent home: move their reference file
into references/{language}/integrations/ and add one row to
references/integrations.md.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* Drop HTML contribution comment from integrations.md
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -90,6 +90,10 @@ Priority and Fairness also apply to tiered workloads (batch vs. real-time), weig
|
||||
- **`references/{your_language}/observability.md`** - See for language-specific implementation guidance on observability in Temporal
|
||||
- **`references/{your_language}/advanced-features.md`** - See for language-specific guidance on advanced Temporal features and language-specific features
|
||||
|
||||
## Third-Party Integrations
|
||||
|
||||
For Temporal plugins and integrations with third-party frameworks and SDKs (Spring Boot, Spring AI, OpenAI Agents SDK, Google ADK, etc.), see **`references/integrations.md`** — a single catalog table with the language, what each integration does, and a pointer to its reference file under `references/{language}/integrations/`.
|
||||
|
||||
## Feedback
|
||||
|
||||
### ALWAYS PROMPT USER TO PROVIDE FEEDBACK AT STARTUP
|
||||
|
||||
@@ -0,0 +1,16 @@
|
||||
# Third-Party Integrations Catalog
|
||||
|
||||
Temporal ships and supports a growing set of integrations with third-party frameworks and SDKs — typically as plugins, contrib modules, or starter libraries. This file is the catalog. Each integration has a dedicated reference under `references/{language}/integrations/`.
|
||||
|
||||
## How to use this catalog
|
||||
|
||||
1. Find the row matching the framework, SDK, or library the user is working with.
|
||||
2. Confirm the language column matches what the user is building in.
|
||||
3. Read the linked reference file for setup, APIs, and pitfalls.
|
||||
4. Cross-check the **Related** column — for AI/LLM integrations, also read `references/core/ai-patterns.md` and the language's `ai-patterns.md`; for Spring-based integrations, read `references/java/integrations/spring-boot.md` first.
|
||||
|
||||
## Catalog
|
||||
|
||||
| Integration | Language(s) | What it does | Reference | Related |
|
||||
|---|---|---|---|---|
|
||||
| Spring Boot (`temporal-spring-boot-starter`) | Java | Auto-configuration of `WorkflowClient`, worker factories, workflow/activity bean registration, lifecycle, testing | `references/java/integrations/spring-boot.md` | `references/java/java.md` |
|
||||
@@ -193,7 +193,7 @@ public class Starter {
|
||||
- `Worker` -- polls a single Task Queue, register workflows and activities on it
|
||||
- Call `factory.start()` to begin polling
|
||||
|
||||
For Spring Boot apps, `temporal-spring-boot-starter` handles all of the above automatically via auto-configuration. See `references/java/spring-boot.md`.
|
||||
For Spring Boot apps, `temporal-spring-boot-starter` handles all of the above automatically via auto-configuration. See `references/java/integrations/spring-boot.md`.
|
||||
|
||||
## File Organization Best Practice
|
||||
|
||||
@@ -254,7 +254,6 @@ See `references/java/testing.md` for info on writing tests.
|
||||
|
||||
### Reference Files
|
||||
|
||||
- **`references/java/spring-boot.md`** - Spring Boot integration: auto-discovery, dependency injection, worker lifecycle, testing
|
||||
- **`references/java/patterns.md`** - Signals, queries, child workflows, saga pattern, etc.
|
||||
- **`references/java/determinism.md`** - Determinism rules and safe alternatives for Java
|
||||
- **`references/java/gotchas.md`** - Java-specific mistakes and anti-patterns
|
||||
@@ -264,3 +263,7 @@ See `references/java/testing.md` for info on writing tests.
|
||||
- **`references/java/advanced-features.md`** - Schedules, worker tuning, and more
|
||||
- **`references/java/data-handling.md`** - Data converters, Jackson, payload encryption
|
||||
- **`references/java/versioning.md`** - Patching API, workflow type versioning, Worker Versioning
|
||||
|
||||
### Java Integrations
|
||||
|
||||
For Java-specific third-party integrations (Spring Boot, Spring AI, etc.), see `references/integrations.md` and filter for Java. Reference files live under `references/java/integrations/`.
|
||||
|
||||
@@ -182,3 +182,7 @@ See `references/python/testing.md` for info on writing tests.
|
||||
- **`references/python/versioning.md`** - Patching API, workflow type versioning, Worker Versioning
|
||||
- **`references/python/determinism-protection.md`** - Python sandbox specifics, forbidden operations, pass-through imports
|
||||
- **`references/python/ai-patterns.md`** - LLM integration, Pydantic data converter, AI workflow patterns
|
||||
|
||||
### Python Integrations
|
||||
|
||||
For Python-specific third-party integrations (OpenAI Agents SDK, Google ADK, etc.), see `references/integrations.md` and filter for Python. Reference files live under `references/python/integrations/`.
|
||||
|
||||
Reference in New Issue
Block a user