Add hosting integration authoring skill - #1433
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
🚀 Dogfood this PR with:
curl -fsSL https://raw.githubusercontent.com/CommunityToolkit/Aspire/main/eng/scripts/dogfood-pr.sh | bash -s -- 1433Or
iex "& { $(irm https://raw.githubusercontent.com/CommunityToolkit/Aspire/main/eng/scripts/dogfood-pr.ps1) } 1433" |
There was a problem hiding this comment.
Pull request overview
Adds a new Copilot skill (hosting-integration-authoring) to guide authoring and reviewing CommunityToolkit Aspire.Hosting integrations, with a self-contained set of reference resources covering common integration archetypes and cross-cutting design concerns (API shape, run/publish/deploy behavior, secrets, endpoints, polyglot exports, testing, etc.).
Changes:
- Introduces the
.agents/skills/hosting-integration-authoring/SKILL.mdentrypoint that defines when to use the skill and how to select the right guidance. - Adds a comprehensive
resources/library of archetype and checklist documents for hosting integration authoring/review in this repo.
Show a summary per file
| File | Description |
|---|---|
| .agents/skills/hosting-integration-authoring/SKILL.md | Skill entrypoint + “which resource to read” selector table and workflow. |
| .agents/skills/hosting-integration-authoring/resources/app-model-fundamentals.md | Core Aspire app-model rules and invariants to apply to all integrations. |
| .agents/skills/hosting-integration-authoring/resources/selector-matrix.md | Classification matrix for choosing applicable archetypes/checklists. |
| .agents/skills/hosting-integration-authoring/resources/archetype-container-backed-service.md | Guidance for container-backed dependency resources (DB/broker/cache/etc.). |
| .agents/skills/hosting-integration-authoring/resources/archetype-admin-and-tool-container.md | Guidance for run-only admin/tool containers and companions. |
| .agents/skills/hosting-integration-authoring/resources/archetype-setup-and-migration-helper.md | Guidance for setup/migration helpers and one-shot resources. |
| .agents/skills/hosting-integration-authoring/resources/archetype-controller-reconciler.md | Guidance for controller/reconciler orchestration patterns. |
| .agents/skills/hosting-integration-authoring/resources/archetype-sidecar-and-middleware.md | Guidance for annotation-driven sidecars/middleware/collectors. |
| .agents/skills/hosting-integration-authoring/resources/archetype-tunnel-and-webhook-bridge.md | Guidance for run-only tunnels/webhook bridges and facade endpoints. |
| .agents/skills/hosting-integration-authoring/resources/archetype-secret-provider.md | Guidance for secret/credential provider resources and late binding. |
| .agents/skills/hosting-integration-authoring/resources/archetype-external-cloud-reference.md | Guidance for external/SaaS reference resources (no local runtime). |
| .agents/skills/hosting-integration-authoring/resources/archetype-azure-provisioning.md | Guidance for Azure provisioning + dual-mode emulator/container patterns. |
| .agents/skills/hosting-integration-authoring/resources/archetype-deployment-target-publisher.md | Guidance for deployment target/publisher integrations and artifacts. |
| .agents/skills/hosting-integration-authoring/resources/deployment-production-readiness.md | Production readiness checklist for deployers that mutate real infra. |
| .agents/skills/hosting-integration-authoring/resources/archetype-language-executable-app.md | Guidance for polyglot/workload executable integrations (Python/Go/Node/etc.). |
| .agents/skills/hosting-integration-authoring/resources/archetype-overlay-configuration.md | Guidance for rare non-resource overlay/configuration-object APIs. |
| .agents/skills/hosting-integration-authoring/resources/api-naming-and-shape.md | Naming/shape rules for consistent C# + polyglot AppHost APIs. |
| .agents/skills/hosting-integration-authoring/resources/run-publish-deploy-modes.md | Rules/patterns for mode-gating behavior and callbacks. |
| .agents/skills/hosting-integration-authoring/resources/eventing-and-initialization.md | Lifecycle hook selection and safe initialization patterns. |
| .agents/skills/hosting-integration-authoring/resources/custom-lifecycle-and-facade-resources.md | Guidance for manual lifecycle/facade resources and endpoint allocation. |
| .agents/skills/hosting-integration-authoring/resources/connection-properties.md | Standard connection property conventions and expression guidance. |
| .agents/skills/hosting-integration-authoring/resources/relationships-and-companions.md | Guidance for parent/child, companions, references, and setup siblings. |
| .agents/skills/hosting-integration-authoring/resources/polyglot-exports.md | Detailed ATS export/analyzer/DTO/callback guidance for generated SDKs. |
| .agents/skills/hosting-integration-authoring/resources/endpoints-and-service-discovery.md | Endpoint naming/ports/reference endpoint/service discovery rules. |
| .agents/skills/hosting-integration-authoring/resources/security-secrets-and-identity.md | Secret handling, artifact hygiene, and identity/RBAC guidance. |
| .agents/skills/hosting-integration-authoring/resources/resource-model-invariants.md | Determinism and invariants around naming, annotations, mutability, transforms. |
| .agents/skills/hosting-integration-authoring/resources/package-and-discoverability.md | Package naming/posture/discoverability + README expectations. |
| .agents/skills/hosting-integration-authoring/resources/dashboard-ux.md | Dashboard UX guidance (icons, URLs, commands, notifications/logs). |
| .agents/skills/hosting-integration-authoring/resources/generated-files-and-container-files.md | Guidance for generated files, embedded resources, init files, container files. |
| .agents/skills/hosting-integration-authoring/resources/cross-platform-tooling.md | Cross-platform requirements for paths, tooling checks, and process args. |
| .agents/skills/hosting-integration-authoring/resources/compatibility-and-deprecation.md | Guidance for experimental/obsolete lifecycle and API baseline handling. |
| .agents/skills/hosting-integration-authoring/resources/testing-and-readmes.md | Testing expectations and README structure guidance for integrations. |
Review details
- Files reviewed: 32/32 changed files
- Comments generated: 0
- Review effort level: Low
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
I believe the existing hosting-integration-creator.agent.md could use a trim after this, maybe some instructions can be replaced with a skills reference like: ## Relevant skills
- aspire
- hosting-integration-authoring |
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
Done in 7dcfc07. I trimmed |
Closes # N/A - skill-only content copy; no linked issue was provided.
Adds a
hosting-integration-authoringCopilot skill under.agents/skills/hosting-integration-authoring/, copied frommicrosoft/aspirecommit4c49bc764with small CommunityToolkit-specific package and example-path adaptations.PR Checklist
Other information
This is skill-only documentation content. It includes
SKILL.mdand all requestedresources/files, includingdeployment-production-readiness.md.No
Aspire.Hosting.GoogleCloudprototype code is included. Lightweight validation coveredgit diff --check, referenced resource-file existence, and a scan for GoogleCloud references.