feat: add ai-release-notes composite action

README.md

@@ -25,6 +25,7 @@ A collection of reusable GitHub Actions and Workflows for Shopware extensions an
 
 | Action | Description | Link |
 |--------|-------------|------|
+| [ai-release-notes](ai-release-notes/) | Generates AI-powered release notes and creates a draft GitHub release | [README](ai-release-notes/README.md) |
 | [build-zip](build-zip/) | Builds the extension zip and validates it | [README](build-zip/README.md) |
 | [store-release](store-release/) | Builds the extension and uploads it to the Shopware Store | [README](store-release/README.md) |
 

ai-release-notes/README.md

@@ -0,0 +1,140 @@
+# AI Release Notes
+
+Generate polished, AI-powered release notes from GitHub's auto-generated changelog and optionally create a draft GitHub release.
+
+The action compares the current tag with the previous one, fetches the raw changelog via the GitHub API, rewrites it using the [GitHub Models API](https://docs.github.com/en/github-models), and creates a draft release with the result.
+
+## Prerequisites
+
+The calling workflow must:
+
+1. **Check out the repository** with full history (`fetch-depth: 0`) so previous tags can be detected.
+2. **Grant permissions** for `contents: write` (to create releases) and `models: read` (to call the AI API).
+
+## Usage
+
+### Minimal Example
+
+Reproduces the default behaviour — no PR links, no authors, bold feature names, sections: *New Features, Improvements, Bug Fixes, Other*.
+
+```yaml
+name: AI Release Notes
+on:
+  push:
+    tags: ["v*"]
+
+permissions:
+  contents: write
+  models: read
+
+jobs:
+  release-notes:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: shopware/github-actions/ai-release-notes@main
+        with:
+          product-name: "My Product"
+```
+
+### Customised Example
+
+Override formatting, sections, and release settings.
+
+```yaml
+      - uses: shopware/github-actions/ai-release-notes@main
+        with:
+          product-name: "Databus"
+          product-description: "A workflow execution engine written in Go"
+          include-pr-links: "true"
+          include-authors: "true"
+          bold-features: "false"
+          sections: "Breaking Changes,New Features,Improvements,Bug Fixes,Internal"
+          collapse-types: "dependency,CI,refactor"
+          tag-pattern: "^v"
+          release-name: "{tag}"
+          draft: "false"
+```
+
+### Generate Notes Without Creating a Release
+
+Use the action as a pure notes generator — for example to post to Slack or append to a changelog file.
+
+```yaml
+      - uses: shopware/github-actions/ai-release-notes@main
+        id: notes
+        with:
+          product-name: "Nexus Contracts"
+          create-release: "false"
+
+      - name: Post to Slack
+        run: echo "${{ steps.notes.outputs.release-notes }}"
+```
+
+## Inputs
+
+| Input | Required | Default | Description |
+|---|---|---|---|
+| `product-name` | **yes** | — | Product name used in the AI prompt |
+| `product-description` | no | `""` | Optional product context for better AI output |
+| `bold-features` | no | `"true"` | Use **bold** for feature names in bullets |
+| `include-pr-links` | no | `"false"` | Include PR links in bullets |
+| `include-authors` | no | `"false"` | Include author attributions in bullets |
+| `sections` | no | `"New Features,Improvements,Bug Fixes,Other"` | Comma-separated list of sections in desired order |
+| `collapse-types` | no | `"dependency,translation,CI"` | Change types collapsed under the last section |
+| `additional-rules` | no | `""` | Extra rules appended to the default prompt |
+| `custom-prompt` | no | `""` | Completely override the system prompt (ignores all formatting inputs) |
+| `model` | no | `"gpt-4o"` | GitHub Models API model name |
+| `temperature` | no | `"0.4"` | AI temperature (`0.0` = deterministic, `1.0` = creative) |
+| `tag-pattern` | no | `"^v"` | Regex pattern to match tags when detecting the previous release |
+| `release-name` | no | `"Release {tag}"` | Release name template — use `{tag}` as placeholder for the tag name |
+| `draft` | no | `"true"` | Create the release as a draft |
+| `prerelease` | no | `"false"` | Mark the release as a prerelease |
+| `create-release` | no | `"true"` | Whether to create a GitHub release (`"false"` = only generate notes) |
+| `github-token` | no | `${{ github.token }}` | GitHub token (needs `models:read` + `contents:write`) |
+
+## Outputs
+
+| Output | Description |
+|---|---|
+| `release-notes` | The AI-generated release notes (Markdown) |
+| `raw-notes` | The raw GitHub-generated changelog before AI rewrite |
+| `release-url` | URL of the created release (empty if `create-release` is `"false"`) |
+| `previous-tag` | The detected previous git tag |
+
+## How the Prompt Works
+
+By default, the action builds a system prompt dynamically from the inputs. The prompt instructs the AI to:
+
+- Group changes under the configured **sections** (omitting empty ones)
+- **Collapse** dependency bumps, translations, and CI changes under the last section
+- Optionally **bold** feature names, include/exclude **PR links** and **authors**
+- Start with a `## Release Notes — <tag>` heading
+- Keep the "Full Changelog" comparison link
+
+### Extending the Default Prompt
+
+Use `additional-rules` to add domain-specific instructions without replacing the entire prompt:
+
+```yaml
+        with:
+          product-name: "My API"
+          additional-rules: |
+            - Always mention the affected API endpoint in parentheses.
+            - Flag any breaking changes with a ⚠️ emoji.
+```
+
+### Full Prompt Override
+
+Use `custom-prompt` when you need complete control. All formatting inputs (`bold-features`, `include-pr-links`, etc.) are ignored when a custom prompt is set:
+
+```yaml
+        with:
+          product-name: "My Product"
+          custom-prompt: |
+            You are a changelog writer. Summarise the changes in 3 bullet points.
+            Be extremely concise. Output Markdown only.
+```