Documentation

How Patchly works

Everything you need to ship and share a changelog.

Quick start

  1. 1

    Create an account

    Sign in with Google or your email at patchly.dawit.dev. No credit card required.

  2. 2

    Create a project

    From the dashboard, click New project. Give it a name and a slug — the slug becomes your public URL: patchly.dawit.dev/your-slug.

  3. 3

    Publish your first entry

    Open the project, click New entry, write in Markdown, then hit Publish. It appears on your public changelog immediately and notifies subscribers.

GitHub integration

Connect a GitHub repo to pull releases directly into Patchly. Each GitHub release becomes a draft entry you can edit before publishing.

  1. Connect: Go to Integrations → GitHub and click Connect repo. Authorize Patchly to read releases from your chosen repository.

  2. Backfill: After connecting, click Sync releases to import existing GitHub releases as draft entries.

  3. Webhook: Patchly registers a webhook on your repo automatically. New releases trigger a draft entry without any manual action.

  4. Manual sync: Use the Sync button on the integration card any time to pull the latest releases.

Embeddable widget

Embed your changelog anywhere with one line of HTML. Paste this inside your app, docs site, or anywhere that accepts HTML.

Embed snippet

<iframe src="https://patchly.dawit.dev/your-slug/widget" style="width:100%;border:none;height:480px" loading="lazy" title="Changelog"> </iframe>

Replace your-slug with your project slug. Adjust height to fit your layout. The widget shows your 10 most recent published entries.

You can also copy the exact snippet from your project dashboard — it has your slug pre-filled.

Zapier

Trigger any Zapier workflow when you publish a changelog entry.

  1. In Zapier, create a new Zap with the Webhooks by Zapier trigger, set it to Catch Hook, and copy the generated URL.

  2. In Patchly, open your project → Integrations → Zapier and paste the URL. Click Save.

  3. Every time you publish an entry, Patchly sends a POST to that URL with title, version, tag, and url fields you can use in downstream Zap actions.

Slack and Discord

Post a message to a Slack channel or Discord server automatically when you publish an entry.

  1. Go to Integrations → Slack (or Discord) and click Connect. Complete the OAuth flow to authorize Patchly.

  2. Choose the channel or server you want notifications posted to.

  3. The next time you publish an entry, Patchly posts the title, version, tag, and a link to the public changelog. No further setup required.

Sentry

Import Sentry releases as draft changelog entries, so your changelog stays in sync with your deploy pipeline.

  1. Go to Integrations → Sentry and click Connect. Complete the OAuth flow.

  2. Once connected, click Configure and enter your Sentry organization slug and project slug — both visible in the Sentry dashboard URL: sentry.io/organizations/[org]/projects/[project]/.

  3. Click Sync releases to pull the latest Sentry releases as draft entries. Edit and publish them from the Patchly dashboard.

Public changelog URL

Every project has a public changelog page at:

patchly.dawit.dev/your-slug

The slug is set when you create a project and can be changed from Project settings. Only published entries appear on the public page. Visitors can subscribe to receive email notifications for new entries.