Everything you need to ship release notes

Quickstart

Pick your track

Two common starting points. Both take about five minutes.

First release

Your first release

The default trigger is a GitHub Release (or GitLab Release / Tag Push). Create one the way you normally would:

git tag v1.0.0
git push origin v1.0.0
# then on GitHub: Releases → Draft a new release → pick the tag → Publish

Within a few seconds, Yanib will:

1. Mark the release as Pending in your dashboard.
2. Fetch all commits and merged PRs between the previous tag and this new one.
3. Call the AI to draft structured entries (Breaking changes, New features, Bug fixes, Other).
4. Notify you via email that the draft is ready to review, and transition the release to Draft.

Open the release in your dashboard, make any edits, and click Publish. Everything downstream happens in one shot.

Review

Reviewing & editing

Once the AI produces a draft, you get a structured editor: each change is a standalone entry you can edit inline, reorder by drag-and-drop, delete, or rewrite with a single click.

AI rewrite — four styles

Hit the sparkle icon on any entry to rewrite it as:

• Concise — one tight sentence.
• Detailed — context, motivation, and what changed.
• User-facing — plain English for non-engineers.
• Technical — for a developer-only audience.

Multi-audience versions

Click Generate multi-audience to produce three parallel versions of the whole release at once — one for developers, one for product managers, one for end users. Switch between them in the release view without re-generating.

Social posts

Click Generate social to draft a Twitter/X post and a LinkedIn post for the release, ready to copy-paste or share straight to your own accounts.

Translation (13 languages)

On your public changelog page, readers can switch language from a picker. Yanib translates the entries on first request, caches the result, and serves cached translations free forever after. Technical terms (API names, function names) are preserved.

Integrations

Slack, Discord, webhooks, email

Integrations are set up once per account or team under Settings → Integrations, then linked per-repo under each repo's Integrations tab. A single Slack channel can receive releases from multiple repos; a single repo can post to multiple channels.

Slack

Paste an incoming webhook URL. You get formatted messages with title, summary, highlighted change types, and a link to the full release.

Discord

Paste a Discord webhook URL. You get a rich embed with color-coded change types (red for breaking, green for features, amber for fixes) and a link to the release.

Generic webhooks (Zapier / Make / n8n / custom)

Any URL that accepts JSON. Yanib sends a structured payload with the release, entries, and metadata — perfect for piping into Zapier, Make, n8n, or your own automation.

Email subscribers

Your public changelog page has a "Subscribe" form. Readers enter their email, confirm via a verification link, and get an email every time you publish. Built-in one-click unsubscribe in every email.

Embeds

SDK & embeds

Drop one script tag on any page and you can use four web components anywhere:

<script src="https://yanib.dev/sdk.js"></script>

<!-- Full release feed -->
<yanib-changelog slug="your-repo-slug" theme="light" limit="5"></yanib-changelog>

<!-- Dismissible announcement bar -->
<yanib-banner slug="your-repo-slug" dismissible="true"></yanib-banner>

<!-- Floating "what's new" bell -->
<yanib-notifications slug="your-repo-slug" position="bottom-right"></yanib-notifications>

<!-- Personal release feed (for profiles, portfolios) -->
<yanib-feed user="your-username" limit="5"></yanib-feed>

The components are framework-agnostic — they work in React, Vue, plain HTML, or any static site generator. Each component fetches live data from Yanib's public API and refreshes on publish.

Public API (for programmatic access)

Prefer to build your own UI? Use the public endpoints:

• GET /api/v1/releases?slug=<slug> — all releases for a repo.
• GET /api/v1/releases/latest?slug=<slug> — latest release only.
• GET /api/feed/<username> — a user's release feed across all their repos.
• GET /api/changelog/<slug>/embed — JSON optimized for widgets (CORS-enabled).

Digests

Team Commit Digest

Digests are different from releases. A release documents a specific version. A digest is a recurring AI-generated velocity report — "here's what your team shipped this week."

Opt-in and schedule

Under Team Settings → Digests, toggle on either or both:

• Team-level digest — one report aggregating all team repos.
• Per-repo digest — one report per active repo.

Pick a cadence (daily, weekly, biweekly, monthly), the day/hour in UTC, and where it should go (Slack, Discord, email).

What you get

Each digest contains:

• A one-paragraph AI summary of the period's work
• Commit counts per repo, per contributor
• Highlighted themes (e.g. "authentication hardening," "performance")
• A per-contributor insight line (opt-out available)
• A hero quote and a "standout moment" from the period

Privacy

If your team prefers no individual attribution, toggle off Show contributor names. The AI prompt is rewritten to speak about "the team" collectively and the dashboard hides the contributor list.

Quiet periods

If zero commits happened in the window, the digest is skipped — no "you shipped nothing" Slack messages.

BYOK

Bring your own AI key

Prefer to pay Anthropic directly and avoid the platform surcharge? Plug in your own Claude API key.

What you get

• Unlimited repos on the Free tier (you're paying the AI bill yourself).
• Model choice — pick your preferred model from the Settings page.
• Isolated cache — your key's AI responses don't mix with the platform cache.

Setup

1. Get a Claude API key from console.anthropic.com.
2. Go to Settings → AI in Yanib.
3. Paste your key and pick your preferred model. Save.

Your key is encrypted at rest with AES-256-GCM before being stored. It's decrypted only inside the AI task context and never logged.

Troubleshooting

Common issues

I pushed a tag but nothing happened

Yanib listens for Release events, not plain tag pushes. Publish a release from the GitHub Releases UI (or API) pointing at your tag. On GitLab, either use the Releases feature or trigger via Tag Push.

I see "GitHub App" on my repo but no releases generate

The App installation under your owner may not cover that specific repo. Go to your GitHub App settings and add the repo to the install, or disconnect and reconnect the repo in Yanib — the fresh connect verifies per-repo coverage and falls back to an OAuth webhook if the App doesn't apply.

A release status is stuck on Generating

Click Retry on the release. If it keeps failing, check Settings → AI — if you're on BYOK, your key may have hit a rate limit or expired. Releases that fail are logged in the Activity feed.

I'm Pro but I see an upgrade modal when connecting a team repo

Personal Pro doesn't cover team repos. Purchase Pro for the team itself from Team Settings → Billing.

The README badge shows "none" after I renamed my repo

It should auto-recover — we track former repo names and fall back to them automatically. If it stays broken, sync the repo manually from Repos → [repo] → Sync from GitHub.

Something else?

Check the Support page for the FAQ, or email support@yanib.dev.