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 Guide
Get up and running with Engammo in under 2 minutes. This guide walks through account creation, GitHub App installation, repository selection, and generating your first release note. No prior configuration or technical knowledge required.
- 1Sign in with your GitHub account
- 2Install the Engammo GitHub App
- 3Select repositories to monitor
- 4Merge a PR and see your first release note
Account and Organization Setup
Configure your Engammo workspace for your team. Learn how to invite team members, set role-based permissions, configure organization-level defaults, and manage billing. This guide covers both individual and team setups.
- 1Create or join an organization
- 2Invite team members with appropriate roles
- 3Set default preferences for release note formatting
- 4Configure billing and subscription plan
Repository Configuration
Fine-tune how Engammo processes each repository. Learn about category mappings, label configuration, branch settings, and per-repository AI behavior. Configure which PRs generate release notes and which are excluded.
- 1Access repository settings from the dashboard
- 2Configure label-to-category mappings
- 3Set the default branch for PR monitoring
- 4Define exclusion rules for internal PRs
Integration Guides
Connect Engammo with your existing tools and workflows.
GitHub Integration
Deep dive into the GitHub App integration. Understand what permissions are requested, how webhook events are processed, how to add or remove repositories after installation, and how to troubleshoot common connection issues.
Slack Integration
Set up Slack notifications for new release notes. Configure which channels receive notifications, customize the message format, and set up per-repository notification routing. Includes setup for both Slack workspace apps and incoming webhooks.
Export and Publishing
Learn how to export release notes in Markdown, HTML, and JSON formats. Configure automatic publishing to your documentation site, blog, or internal wiki. Set up custom templates for consistent formatting across all exports.
SSO and Enterprise Setup
Configure SAML-based single sign-on for your organization. Set up audit logging, define custom roles and permissions, and integrate with your identity provider. Covers Okta, Azure AD, and Google Workspace configurations.
Topic Guides
Understanding AI-Generated Summaries
How Engammo's AI engine processes PR data to generate human-readable summaries. Learn about the analysis pipeline, how categories are inferred, and how to improve summary quality through better PR descriptions and labels.
Tag-Based Release Notes
Generate release notes that cover all changes between two Git tags. Useful for versioned releases, SDK changelogs, and structured release processes. Learn how to select tags, customize grouping, and publish tag-based notes.
Custom Categories and Labels
Define custom categories beyond the defaults (feature, fix, improvement). Map GitHub labels to categories, set priority ordering, and configure how uncategorized PRs are handled. Includes best practices for label taxonomies.
Team Workflows and Permissions
Set up role-based access control for your team. Define who can generate, edit, review, and publish release notes. Configure approval workflows and review requirements for published changelogs.
Troubleshooting Common Issues
Solutions for the most common issues: missing PRs, incorrect categorization, webhook delivery failures, and permission errors. Each issue includes diagnostic steps and resolution instructions.
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 with GitHub and selecting repositories. No command-line tools, API tokens, or configuration files are needed for basic usage.
Is there a getting started tutorial with examples?
Yes. The Quick Start Guide walks through the entire setup process step by step, from account creation to generating your first release note. Each step includes screenshots and expected outcomes so you can verify your setup is working correctly.
How do I configure Engammo for a monorepo?
Engammo works with monorepos the same way it works with single-package repositories. It monitors merged PRs at the repository level. You can use labels and path-based rules to categorize changes by package or service within the monorepo.
Where can I find API documentation?
Full API documentation is available on the API Reference page. It covers authentication, available endpoints, request/response formats, rate limits, and code examples in multiple programming languages.
How do I set up Slack notifications?
Navigate to your organization settings in the Engammo dashboard and select the Slack integration. You will be guided through connecting your Slack workspace and selecting the channels where notifications should be sent. Per-repository channel routing is also available.
Can I use Engammo with GitHub Enterprise?
Yes. Engammo supports GitHub Enterprise Cloud. GitHub Enterprise Server (self-hosted) support is available on the Enterprise plan with custom configuration. Contact our sales team for Enterprise Server setup assistance.
How do I invite team members?
Go to your organization settings and click "Invite Members." Enter the email addresses of your team members and assign them a role (Admin, Editor, or Viewer). They will receive an email invitation with a link to join your Engammo organization.
What should I do if a release note is inaccurate?
Click the "Edit" button on any release note to modify the content. You can also click "Regenerate" to have the AI produce a new summary. If inaccuracies are persistent, check that your PR descriptions and labels are providing sufficient context for the AI to work with.
Start building with Engammo
Set up automated release notes for your GitHub repositories in under 2 minutes. Free for up to 5 repositories.