Kodiak

Kodiak

  • Docs
  • Help
  • Changelog
  • GitHub
  • Dashboard
  • Install

›Getting Started

Getting Started

  • Quick Start
  • Configuration Reference
  • Features
  • Recipes
  • Dashboard
  • Billing
  • Troubleshooting
  • Permissions and Privacy
  • Self Hosting
  • Why and How
  • Prior Art / Alternatives

Contributing

  • Contributing
  • Sponsoring
Edit

Quick Start

  1. Install the GitHub app

  2. Create a .kodiak.toml file in the root of your repository with the following contents

    # .kodiak.toml
    # Minimal config. version is the only required field.
    version = 1
    
  3. Configure GitHub branch protection. Setup required status checks to prevent failing PRs from being merged.

  4. Create an automerge label (default: "automerge")

  5. Start auto merging PRs with Kodiak

    Label your PRs with your automerge label and let Kodiak do the rest! 🎉

If you have any questions please review our help page.

Last updated on 7/3/2020
Configuration Reference →
Kodiak
Docs
Quick StartRecipesWhy and HowConfiguration Reference
More
InstallGitHubChangelogHelp
Legal
Terms and ConditionPrivacy Policy
Copyright © 2024 Kodiak Authors