Back to Blog

How to Set Up Automated Changelogs for Your GitHub Repository in 5 Minutes

Follow this step-by-step tutorial to integrate ChangeDog with your GitHub repository and start generating AI-powered changelogs automatically.

Posted by

GitHub integration with ChangeDog

Prerequisites

Before you begin, make sure you have:

  • A GitHub account with admin access to your repository
  • A ChangeDog account (sign up at changedog.top)
  • At least a few commits in your repository

Step 1: Sign in with GitHub

Visit changedog.top and click "Sign in with GitHub". This will authorize ChangeDog to read your repositories (we only request read-only access to commits).

Step 2: Create Your First Project

After signing in, you'll see the "Create Project" wizard. Fill in the following:

  • Project Name: A friendly name for your app (e.g., "My Awesome App")
  • Repository URL: Your GitHub repo URL (e.g., https://github.com/yourname/yourrepo)
  • Subdomain: Choose a unique subdomain for your public changelog (e.g., myapp.changedog.top)

Click "Create Project" and ChangeDog will import the last 20 commits from your repository.

Step 3: Configure the GitHub Webhook

To receive updates automatically when you push new commits, you need to set up a webhook:

  • Go to your GitHub repository settings
  • Click "Webhooks" in the left sidebar
  • Click "Add webhook"
  • Paste the webhook URL provided by ChangeDog (found in your project settings)
  • Set content type to application/json
  • Paste the webhook secret from ChangeDog
  • Select "Just the push event"
  • Click "Add webhook"
# Example webhook configuration
Payload URL: https://changedog.top/api/webhook/github/YOUR_PROJECT_ID
Content type: application/json
Secret: your_webhook_secret_here
Events: Push events

Step 4: Review and Publish Your First Changelog

ChangeDog will automatically generate a draft changelog from your imported commits. Go to your dashboard, review the AI-generated content, make any edits if needed, and click "Publish".

Your changelog is now live at yoursubdomain.changedog.top!

Step 5: Embed the Widget on Your Website

To let users see updates directly on your website, add the ChangeDog widget. Copy the embed code from your project settings and paste it before the closing </body> tag:

<script src="https://changedog.top/widget.js"
        data-project="YOUR_PROJECT_ID"
        data-theme="auto">
</script>

That's it! You now have a fully automated changelog system powered by AI.