Engammo Documentation
Everything you need to set up, configure, and get the most out of Engammo. From initial setup to advanced integrations, these guides cover the full range of release note automation capabilities.
Getting Started
Quick Start
Get started in a few minutes: sign in, install the GitHub App, select your repositories, and merge a pull request. No configuration files or CI changes required.
- 1Sign in with GitHub or an email link
- 2Install the Engammo GitHub App
- 3Select repositories to monitor
- 4Merge a PR and see your first release note
Workspace and Team Setup
Invite team members as Admins or Members, rename your workspace, and manage your plan. Owners manage billing; Admins manage repositories and the team.
- 1Create your workspace
- 2Invite team members from Settings > Team
- 3Choose whether AI summaries are enabled
- 4Manage your plan from Settings > Billing
Repository Settings
Enable or disable each repository, toggle AI summaries, generate notes automatically when you push a new Git tag, and configure FAQ generation.
- 1Open the repository from the dashboard
- 2Toggle AI summaries
- 3Enable auto-generation from tags
- 4Configure FAQ generation
Integration Guides
Connect Engammo with your existing tools and workflows.
GitHub Integration
Engammo connects through a GitHub App. It receives merged pull request events, reads the PR title, description, labels, and changed files, and can optionally create a version tag on each merge. Add or remove repositories at any time from your GitHub App installation settings.
Widget and RSS
Show release notes and FAQs on any site with one script tag, in English, Italian, or Spanish. Every public updates page also has an RSS feed.
Publishing
Publish release notes to a hosted updates page that is internal or public. Pick one of eight themes or import colors, font and logo from your site, and match the widget colors to your brand.
Team Roles
Workspaces have three roles. Owners manage billing and can delete the workspace. Admins manage repositories, widgets, integrations, and the team. Members generate and edit release notes.
Topic Guides
Understanding AI-Generated Summaries
How Engammo turns PR data into human-readable summaries, how GitHub labels map to tags, and how to improve summary quality through better PR descriptions and labels.
Tag-Based Release Notes
Generate a release note covering every change between two Git tags, either manually or automatically when a new tag is pushed. Useful for versioned releases and SDK changelogs.
Labels and Tags
Engammo maps common GitHub labels to standard tags: bug and fix become fix; feature and enhancement become feature; breaking becomes breaking-change; plus security, refactor, docs, infra, chore, and dependencies. Other labels are kept as they are.
Kommander Integration
Sync the FAQs generated from your release notes to your Kommander assistant so it can answer questions about what shipped.
Need More Help?
Frequently Asked Questions
What technical knowledge do I need to use Engammo?
No special technical knowledge is required. If you can merge a pull request on GitHub, you can use Engammo. The setup process involves signing in and selecting repositories. No command-line tools, API tokens, or configuration files are needed.
How do I configure Engammo for a monorepo?
Engammo works with monorepos the same way it works with single-package repositories. It generates a note for each merged PR at the repository level.
Is there an API?
Engammo offers read-only public endpoints for published release notes and FAQs (JSON) and an RSS feed. See the Public API page. There is no API for generating or editing notes yet.
Can I use Engammo with GitHub Enterprise?
Engammo works with organizations on GitHub.com, including GitHub Enterprise Cloud organizations hosted on github.com. GitHub Enterprise Server (self-hosted) is not supported.
How do I invite team members?
Go to Settings > Team and click "Invite Team Member." Enter an email address and choose a role (Admin or Member). They will receive an email invitation to join your workspace.
What should I do if a release note is inaccurate?
Edit any release note to change its content, or click "Regenerate" to have the AI produce a new summary. If inaccuracies persist, check that your PR descriptions and labels give the AI enough context.
Start building with Engammo
Set up automated release notes for your GitHub repositories in minutes. 14-day free trial, cancel anytime.