> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shipstar.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# generate_release_notes_email

> Kick off generation of a release notes email from recent commits

Analyses commits on the project's tracked GitHub repositories and kicks off a background task that generates a release notes email. Returns immediately with a pending content record.

## Arguments

| Name           | Type                                       | Default           | Description                                                                                                                                                                                                    |
| -------------- | ------------------------------------------ | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `start_date`   | string (ISO-8601)                          | 7 days ago        | Earliest commit timestamp to include.                                                                                                                                                                          |
| `end_date`     | string (ISO-8601)                          | now               | Latest commit timestamp to include.                                                                                                                                                                            |
| `product_name` | string                                     | project name      | Override the product name used in the email.                                                                                                                                                                   |
| `idea`         | object                                     | —                 | Optional `{title, summary}` suggestion to focus the email on; commits unrelated to the idea are ignored.                                                                                                       |
| `audience`     | `"technical"` \| `"business"` \| `"mixed"` | project default   | Technical depth of the writing. Omit to use the project's [content guidelines](/guides/content-guidelines) default.                                                                                            |
| `instructions` | string (≤ 2000 chars)                      | project default   | Free-text guidance on scope, tone, or terminology, e.g. `"Don't mention marketing website changes"`. Omit to use the project default.                                                                          |
| `repos`        | string\[]                                  | all tracked repos | Restrict the commit source to these tracked repositories (full names, e.g. `["acme/backend"]`), as listed by [`get_project_context`](/mcp/project/get-project-context). Omit to use every active tracked repo. |

## Returns

```json theme={null}
{
  "content_id": "7f5e2c1a-...",
  "status": "pending"
}
```

Poll [`get_generation_status`](/mcp/lifecycle/get-generation-status) until the status is `completed`, review the draft with [`get_content_draft`](/mcp/lifecycle/get-content-draft), then deliver it to mailing lists with [`send_release_email`](/mcp/email/send-release-email).

## Errors

* `No GitHub account connected. Connect GitHub in Sources first.`
* `No active tracked repositories. Add repos in Sources first.`
* `Monthly credit limit reached (10/10 used). Upgrade your plan to keep generating content.`

## Example prompts

> "Draft a release notes email covering everything we shipped this sprint."

> "Generate a release email for the 2026-07-01 → 2026-07-31 window, focused on the new billing dashboard."