| name | tcgc-newsletter |
| description | Compose a TCGC monthly newsletter for @azure-tools/typespec-client-generator-core. Use when: writing newsletter, creating release notes, summarizing TCGC changes, drafting monthly update. |
| argument-hint | Provide the target version range (e.g., since 0.67.1) and any emphasis areas |
TCGC Monthly Newsletter
Generate a monthly newsletter summarizing changes in @azure-tools/typespec-client-generator-core across one or more releases.
Reference
Previous newsletters live in packages/typespec-client-generator-core/newsletter/. Read the latest one to match tone, structure, and markdown style. New newsletters should be created in the same directory as <version>.md.
Inputs
Confirm with the user:
- Version range: Starting version (exclusive) through current, e.g., "since 0.67.1".
- Emphasis areas: Topics to highlight as ⭐ features (e.g., client changes, performance).
Procedure
1. Gather Changes
- Read the latest newsletter in
packages/typespec-client-generator-core/newsletter/ for style reference.
- Read
packages/typespec-client-generator-core/CHANGELOG.md for all entries in the version range.
- Read
packages/typespec-client-generator-core/package.json for current version.
2. Research Key PRs
For major features, breaking changes, and performance improvements, fetch the PR from https://github.com/Azure/typespec-azure/pull/<number> to get motivation, migration guidance, and benchmark results.
3. Validate Code Examples
For every TypeSpec code example, search for corresponding tests under packages/typespec-client-generator-core/test/ and verify syntax matches real usage. Tests are the source of truth.
4. Write the Newsletter
Follow the structure and style of the previous newsletter. Key rules:
- Audience: Spec authors and emitter authors. No internal implementation details.
- Markdown:
#/##/### headings, - bullets (not •), ```typespec code blocks, [#NNNN](url) PR links, backtick-wrapped APIs in headings.
- Performance: Show benchmark results as tables when available.
- Bottom line: 2-3 short paragraphs, concise, aligned with detailed sections above.
- Documentation links: Every section and summary bullet should include links to the relevant documentation page on
https://azure.github.io/typespec-azure/. Use the following pattern:
- In the summary bullets at the top, append
— [docs](url) to each item that has a doc page.
- Under each
## section heading, add a 📖 **Docs**: [Page Title](url) line linking to the howto or reference page(s). Separate multiple links with ·.
- For bug-fix sections that reference multiple decorators, add a single
Related docs: line with links to each decorator's howto or reference page.
- Look for doc pages under these URL patterns:
- Howtos:
https://azure.github.io/typespec-azure/docs/howtos/generate-client-libraries/<slug>/
- Decorator reference:
https://azure.github.io/typespec-azure/docs/libraries/typespec-client-generator-core/reference/decorators/#@Azure.ClientGenerator.Core.<name>
- If no documentation page exists for a topic (e.g., performance improvements, internal APIs), omit the link — do not fabricate URLs.
5. Review Checklist