sdk-release-checklist

Validates SDK releases across code, website, changelogs, and CI integration points.

138|5|Updated Sep 19, 2024
One-click install
npx skills add https://github.com/macalbert/envilder --skill sdk-release-checklist-macalbert
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: sdk-release-checklist
Source: https://github.com/macalbert/envilder/tree/main/.github/skills/sdk-release-checklist
Command: npx skills add https://github.com/macalbert/envilder --skill sdk-release-checklist-macalbert

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Releasing a new SDK or bumping an SDK version touches many disconnected places: source code, version files, website badges, documentation pages, changelogs, i18n translations, and CI workflows. Missing any one of them causes version drift, broken badges, or untranslated pages. This Skill provides a mandatory checklist that keeps every integration point in sync. ## Core Features & Use Cases - New SDK Onboarding Checklist: Covers source layout, canonical version files (.csproj, pyproject.toml, package.json), Astro version badge wiring, docs sections, changelog pages in three locales, and CI configuration. - Version Bump Checklist: A short path for existing SDKs covering version source updates, changelog entries, and build verification. - Validation Commands: Includes build and grep-based checks to confirm version badges and changelog entries render correctly in the built website. - Use Case: When adding a Go SDK to the Envilder project, follow the checklist to wire its version into astro.config.mjs, add i18n keys to all locale files, create its changelog page, and verify the built site renders the new badge. ## Quick Start Ask the assistant to run the SDK release checklist for the new SDK you are adding and verify every integration point is connected.

Frequently Asked Questions about sdk-release-checklist

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I add a new SDK to a multi-runtime project?

Follow the full checklist: add source and tests under src/sdks/{runtime}/, define a canonical version file, wire the version into astro.config.mjs with a Vite define global, add docs sections and i18n keys for all locales, create a changelog page, and update CI.

How do I release a new version of an existing SDK?

Bump the version in the canonical source file (csproj, pyproject.toml, or package.json), add a changelog entry to docs/changelogs/sdk-{runtime}.md, and rebuild the website. Version badges update automatically through the build-time define globals.

Why is my SDK version badge not updating after a version bump?

Vite caches define values, so restart the dev server after bumping the version. Also confirm the version is read dynamically via the __SDK_*_VERSION__ global rather than hardcoded in the badge component.

How do I keep changelog pages consistent across multiple locales?

Add the product entry to the products array in all three changelog pages (en, ca, es), add the sidebar nav block in each, and register the categorySdk{Runtime} i18n key in types.ts so TypeScript flags any missing locale keys.

What are common mistakes when wiring a new SDK into a website?

Common pitfalls include hardcoding versions in badges, forgetting the changelog sidebar in non-English locales, using the wrong parsed[N] index after adding a product, and missing i18n keys in one locale file.