Documentation

Everything you need to set up and use ShipLog for your projects.

Quick Start

1

Create your account

Sign up with GitHub OAuth. We'll automatically detect your repositories.

2

Connect a repository

Select which repos to generate changelogs for. ShipLog installs as a GitHub App.

3

Generate your first changelog

Create a release or tag, and ShipLog generates entries automatically. Or use the dashboard to create entries manually.

4

Share with your users

Your public changelog page is live. Embed the widget on your site for in-app updates.

Embeddable Widget

Add the ShipLog changelog widget to any website with a single script tag:

<!-- ShipLog Changelog Widget -->
<div id="shiplog-widget"></div>
<script
  src="https://shiplog.dev/widget.js"
  data-project="your-project-id"
  data-theme="dark"
  data-limit="5"
  async
></script>

Widget Options

AttributeDefaultDescription
data-projectrequiredYour ShipLog project ID
data-theme"dark""dark", "light", or "auto"
data-limit"5"Number of releases to show
data-compact"false"Compact mode (true/false)
data-categories"all"Filter by category

API Reference

Access your changelog data programmatically with the ShipLog REST API.

GET/api/v1/releases

List all releases for a project.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://shiplog.dev/api/v1/releases?project=your-project-id
GET/api/v1/releases/:version

Get a specific release by version.

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://shiplog.dev/api/v1/releases/2.3.0
POST/api/v1/releases

Create a new release entry.

curl -X POST -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"version":"2.4.0","title":"New Release","changes":[...]}' \
  https://shiplog.dev/api/v1/releases

Webhooks

Receive notifications when new releases are published. Configure webhooks in your project settings.

// Webhook payload
{
  "event": "release.published",
  "project": "your-project-id",
  "release": {
    "version": "2.4.0",
    "title": "New Features & Fixes",
    "date": "2026-01-31",
    "changes": [
      { "category": "added", "text": "New dashboard analytics" },
      { "category": "fixed", "text": "Widget loading performance" }
    ]
  }
}